Create a new metadata entry.

Creates a metadata key-value pair on a subscription. Will fail if the key already exists (409).
Note that you are not allowed to enter any personal data relating to end users or any third parties.

Path Parameters

id string required
Possible values: Value must match regular expression ^[85,97]{2}[23456789ABCDEFGHJKLMNPQRSTUVWXYZ]{16}$
IoT subscription ID to perform request on.

application/json

Request Body required

Specifies the new metadata key and value pair.

key string required
Possible values: non-empty and <= 100 characters
The metadata key
value string required
Possible values: non-empty and <= 100 characters
The metadata value

Responses

Metadata created successfully.

BadRequest

Response Headers

Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string

application/json

Schema
Example (from schema)

Schema

name string
message string
errors object[]
message string
errorCode string
path string
Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Unauthorized. Your token is not valid.

Response Headers

Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string

application/json

Schema
Example (from schema)

Schema

name string
message string
errors object[]
message string
errorCode string
path string
Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Forbidden. You are not allowed to access the requested resource.

Response Headers

Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string

application/json

Schema
Example (from schema)

Schema

name string
message string
errors object[]
message string
errorCode string
path string
Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

The specified resource was not found

Response Headers

Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string

application/json

Schema
Example (from schema)

Schema

name string
message string
errors object[]
message string
errorCode string
path string
Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Conflict. Specified resource conflicting with an another resource.

Response Headers

Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string

application/json

Schema
Example (from schema)

Schema

name string
message string
errors object[]
message string
errorCode string
path string
Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Internal Server Error

Response Headers

Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string

application/json

Schema
Example (from schema)

Schema

name string
message string
errors object[]
message string
errorCode string
path string
Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Create a new metadata entry.​

Create a new metadata entry.