This page contains a full list of all routes supported by The Things Stack HTTP (REST) API, sorted by services.
-
All routes are prepended with
/api/v3, except where noted. -
Set the
User-AgentHTTP header containing the name and version of the client. That way, a network operator can help finding out potential issues using the logs.
The Things Stack HTTP (REST) API Reference
Version: v3.32.0
AlertNotificationReceiverRegistry
Manage alert notification receivers.
get
/alerts/notifications/receivers
List existing alert notification receivers.
Returns all receivers if no identifiers are provided.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
field_mask |
string | ||
order |
string | Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. | |
limit |
integer | Limit the number of results per page. | |
page |
integer | Page number for pagination. 0 is interpreted as 1. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"receivers": {
"items": {
"properties": {
"created_at": {
"format": "date-time",
"type": "string"
},
"email": {
"properties": {
"recipient": {
"type": "string"
}
},
"type": "object"
},
"ids": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"sms": {
"properties": {
"phone_number": {
"description": "According to the international phone numbering plan (ITU-T E. 164)\nphone numbers cannot contain less than 7 digits and more than 15 digits.\nThe validation is done via an regex and accounts for the '+' formating character.",
"type": "string"
}
},
"type": "object"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"webhook": {
"properties": {
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/alerts/notifications/receivers
Create a new alert notification receiver.
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"receiver": {
"properties": {
"created_at": {
"format": "date-time",
"type": "string"
},
"email": {
"properties": {
"recipient": {
"type": "string"
}
},
"type": "object"
},
"ids": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"sms": {
"properties": {
"phone_number": {
"description": "According to the international phone numbering plan (ITU-T E. 164)\nphone numbers cannot contain less than 7 digits and more than 15 digits.\nThe validation is done via an regex and accounts for the '+' formating character.",
"type": "string"
}
},
"type": "object"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"webhook": {
"properties": {
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"created_at": {
"format": "date-time",
"type": "string"
},
"email": {
"properties": {
"recipient": {
"type": "string"
}
},
"type": "object"
},
"ids": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"sms": {
"properties": {
"phone_number": {
"description": "According to the international phone numbering plan (ITU-T E. 164)\nphone numbers cannot contain less than 7 digits and more than 15 digits.\nThe validation is done via an regex and accounts for the '+' formating character.",
"type": "string"
}
},
"type": "object"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"webhook": {
"properties": {
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"url": {
"type": "string"
}
},
"type": "object"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/alerts/notifications/receivers/{ids.receiver_id}
Get an existing alert notification receiver.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
ids.receiver_id |
string | true | |
field_mask |
string |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"created_at": {
"format": "date-time",
"type": "string"
},
"email": {
"properties": {
"recipient": {
"type": "string"
}
},
"type": "object"
},
"ids": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"sms": {
"properties": {
"phone_number": {
"description": "According to the international phone numbering plan (ITU-T E. 164)\nphone numbers cannot contain less than 7 digits and more than 15 digits.\nThe validation is done via an regex and accounts for the '+' formating character.",
"type": "string"
}
},
"type": "object"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"webhook": {
"properties": {
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"url": {
"type": "string"
}
},
"type": "object"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
put
/alerts/notifications/receivers/{receiver.ids.receiver_id}
Update an existing alert notification receiver.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
receiver.ids.receiver_id |
string | true |
Request Body
Show JSON Schema
{
"field_mask": {
"type": "string"
},
"receiver": {
"properties": {
"created_at": {
"format": "date-time",
"type": "string"
},
"email": {
"properties": {
"recipient": {
"type": "string"
}
},
"type": "object"
},
"ids": {
"description": "The identifiers of the receiver. These can be seen by any admin user in the network.",
"title": "The identifiers of the receiver. These can be seen by any admin user in the network.",
"type": "object"
},
"name": {
"type": "string"
},
"sms": {
"properties": {
"phone_number": {
"description": "According to the international phone numbering plan (ITU-T E. 164)\nphone numbers cannot contain less than 7 digits and more than 15 digits.\nThe validation is done via an regex and accounts for the '+' formating character.",
"type": "string"
}
},
"type": "object"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"webhook": {
"properties": {
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"created_at": {
"format": "date-time",
"type": "string"
},
"email": {
"properties": {
"recipient": {
"type": "string"
}
},
"type": "object"
},
"ids": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"sms": {
"properties": {
"phone_number": {
"description": "According to the international phone numbering plan (ITU-T E. 164)\nphone numbers cannot contain less than 7 digits and more than 15 digits.\nThe validation is done via an regex and accounts for the '+' formating character.",
"type": "string"
}
},
"type": "object"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"webhook": {
"properties": {
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"url": {
"type": "string"
}
},
"type": "object"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
delete
/alerts/notifications/receivers/{receiver_id}
Delete an existing alert notification receiver.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
receiver_id |
string | true |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. | None |
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
AlertNotificationProfileRegistry
Manage alert notification profiles.
get
/alerts/notifications/profiles
List existing alert notification profiles.
Returns all profiles if no identifiers are provided. If provided, the identifiers are used to filter which profiles are returned.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
field_mask |
string | ||
order |
string | Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. | |
limit |
integer | Limit the number of results per page. | |
page |
integer | Page number for pagination. 0 is interpreted as 1. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"profiles": {
"items": {
"properties": {
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"profile_id": {
"type": "string"
}
},
"type": "object"
},
"is_default": {
"description": "Whether this profile is the default alert notification profile for the network.",
"type": "boolean"
},
"name": {
"type": "string"
},
"receivers_ids": {
"description": "List of receivers that will be notified when an alert is triggered for this profile.",
"items": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/alerts/notifications/profiles
Create a new alert notification profile.
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"profile": {
"properties": {
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"profile_id": {
"type": "string"
}
},
"type": "object"
},
"is_default": {
"description": "Whether this profile is the default alert notification profile for the network.",
"type": "boolean"
},
"name": {
"type": "string"
},
"receivers_ids": {
"description": "List of receivers that will be notified when an alert is triggered for this profile.",
"items": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"profile_id": {
"type": "string"
}
},
"type": "object"
},
"is_default": {
"description": "Whether this profile is the default alert notification profile for the network.",
"type": "boolean"
},
"name": {
"type": "string"
},
"receivers_ids": {
"description": "List of receivers that will be notified when an alert is triggered for this profile.",
"items": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/alerts/notifications/profiles/default
Get the default alert notification profile.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
field_mask |
string |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"profile_id": {
"type": "string"
}
},
"type": "object"
},
"is_default": {
"description": "Whether this profile is the default alert notification profile for the network.",
"type": "boolean"
},
"name": {
"type": "string"
},
"receivers_ids": {
"description": "List of receivers that will be notified when an alert is triggered for this profile.",
"items": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/alerts/notifications/profiles/{ids.profile_id}
Get an existing alert notification profile.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
ids.profile_id |
string | true | |
field_mask |
string |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"profile_id": {
"type": "string"
}
},
"type": "object"
},
"is_default": {
"description": "Whether this profile is the default alert notification profile for the network.",
"type": "boolean"
},
"name": {
"type": "string"
},
"receivers_ids": {
"description": "List of receivers that will be notified when an alert is triggered for this profile.",
"items": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
put
/alerts/notifications/profiles/{profile.ids.profile_id}
Update an existing alert notification profile.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
profile.ids.profile_id |
string | true |
Request Body
Show JSON Schema
{
"field_mask": {
"type": "string"
},
"profile": {
"properties": {
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"description": "The identifiers of the profile. These are public and can be seen by any authenticated user in the network.",
"title": "The identifiers of the profile. These are public and can be seen by any authenticated user in the network.",
"type": "object"
},
"is_default": {
"description": "Whether this profile is the default alert notification profile for the network.",
"type": "boolean"
},
"name": {
"type": "string"
},
"receivers_ids": {
"description": "List of receivers that will be notified when an alert is triggered for this profile.",
"items": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"profile_id": {
"type": "string"
}
},
"type": "object"
},
"is_default": {
"description": "Whether this profile is the default alert notification profile for the network.",
"type": "boolean"
},
"name": {
"type": "string"
},
"receivers_ids": {
"description": "List of receivers that will be notified when an alert is triggered for this profile.",
"items": {
"properties": {
"receiver_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
delete
/alerts/notifications/profiles/{profile_id}
Delete an existing alert notification profile.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
profile_id |
string | true |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. | None |
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
Ars
Manage The Things Stack Alert Routing Server.
get
/ars/configuration
Request Parameters
| Field | Type | Required | Description |
|---|
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"configuration": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
AuthenticationProviderRegistry
Manage external authentication providers.
get
/authentication_providers
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
field_mask |
string | ||
order |
string | Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. | |
limit |
integer | Limit the number of results per page. | |
page |
integer | Page number for pagination. 0 is interpreted as 1. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"providers": {
"items": {
"properties": {
"allow_registrations": {
"type": "boolean"
},
"allowed_email_domains": {
"description": "Allowed email domains for this provider.\nIf this field is set, only emails with the specified domains will be allowed to login.\nThe server also skips checking the `email_verified` field of the claims token.\nWe highly recommend admins of such providers to not allow\nusers to change their email addresses with the provider due to lack of verification.",
"items": {
"type": "string"
},
"type": "array"
},
"configuration": {
"properties": {
"oidc": {
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"provider_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"ids": {
"properties": {
"provider_id": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/authentication_providers
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"provider": {
"properties": {
"allow_registrations": {
"type": "boolean"
},
"allowed_email_domains": {
"description": "Allowed email domains for this provider.\nIf this field is set, only emails with the specified domains will be allowed to login.\nThe server also skips checking the `email_verified` field of the claims token.\nWe highly recommend admins of such providers to not allow\nusers to change their email addresses with the provider due to lack of verification.",
"items": {
"type": "string"
},
"type": "array"
},
"configuration": {
"properties": {
"oidc": {
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"provider_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"ids": {
"properties": {
"provider_id": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"allow_registrations": {
"type": "boolean"
},
"allowed_email_domains": {
"description": "Allowed email domains for this provider.\nIf this field is set, only emails with the specified domains will be allowed to login.\nThe server also skips checking the `email_verified` field of the claims token.\nWe highly recommend admins of such providers to not allow\nusers to change their email addresses with the provider due to lack of verification.",
"items": {
"type": "string"
},
"type": "array"
},
"configuration": {
"properties": {
"oidc": {
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"provider_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"ids": {
"properties": {
"provider_id": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/authentication_providers/{ids.provider_id}
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
ids.provider_id |
string | true | |
field_mask |
string |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"allow_registrations": {
"type": "boolean"
},
"allowed_email_domains": {
"description": "Allowed email domains for this provider.\nIf this field is set, only emails with the specified domains will be allowed to login.\nThe server also skips checking the `email_verified` field of the claims token.\nWe highly recommend admins of such providers to not allow\nusers to change their email addresses with the provider due to lack of verification.",
"items": {
"type": "string"
},
"type": "array"
},
"configuration": {
"properties": {
"oidc": {
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"provider_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"ids": {
"properties": {
"provider_id": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
put
/authentication_providers/{provider.ids.provider_id}
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
provider.ids.provider_id |
string | true |
Request Body
Show JSON Schema
{
"field_mask": {
"type": "string"
},
"provider": {
"properties": {
"allow_registrations": {
"type": "boolean"
},
"allowed_email_domains": {
"description": "Allowed email domains for this provider.\nIf this field is set, only emails with the specified domains will be allowed to login.\nThe server also skips checking the `email_verified` field of the claims token.\nWe highly recommend admins of such providers to not allow\nusers to change their email addresses with the provider due to lack of verification.",
"items": {
"type": "string"
},
"type": "array"
},
"configuration": {
"properties": {
"oidc": {
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"provider_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"ids": {
"type": "object"
},
"name": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"allow_registrations": {
"type": "boolean"
},
"allowed_email_domains": {
"description": "Allowed email domains for this provider.\nIf this field is set, only emails with the specified domains will be allowed to login.\nThe server also skips checking the `email_verified` field of the claims token.\nWe highly recommend admins of such providers to not allow\nusers to change their email addresses with the provider due to lack of verification.",
"items": {
"type": "string"
},
"type": "array"
},
"configuration": {
"properties": {
"oidc": {
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"provider_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"ids": {
"properties": {
"provider_id": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
delete
/authentication_providers/{provider_id}
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
provider_id |
string | true |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. | None |
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
ExternalUserRegistry
Manage external users (users linked to external identity providers).
post
/authentication_providers/{external_user.provider_ids.provider_id}/external_users
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
external_user.provider_ids.provider_id |
string | true |
Request Body
Show JSON Schema
{
"external_user": {
"properties": {
"created_at": {
"format": "date-time",
"type": "string"
},
"external_id": {
"type": "string"
},
"provider_ids": {
"type": "object"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"created_at": {
"format": "date-time",
"type": "string"
},
"external_id": {
"type": "string"
},
"provider_ids": {
"properties": {
"provider_id": {
"type": "string"
}
},
"type": "object"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
delete
/authentication_providers/{provider_ids.provider_id}/external_users/{external_id}
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
provider_ids.provider_id |
string | true | |
external_id |
string | true |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. | None |
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/authentication_providers/{provider_ids.provider_id}/external_users/{external_id}
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
provider_ids.provider_id |
string | true | |
external_id |
string | true |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"created_at": {
"format": "date-time",
"type": "string"
},
"external_id": {
"type": "string"
},
"provider_ids": {
"properties": {
"provider_id": {
"type": "string"
}
},
"type": "object"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/authentication_providers/{provider_ids.provider_id}/users/{user_ids.user_id}
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
provider_ids.provider_id |
string | true | |
user_ids.user_id |
string | true | This ID shares namespace with organization IDs. |
user_ids.email |
string | Secondary identifier, which can only be used in specific requests. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"created_at": {
"format": "date-time",
"type": "string"
},
"external_id": {
"type": "string"
},
"provider_ids": {
"properties": {
"provider_id": {
"type": "string"
}
},
"type": "object"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
Noc
Query historical aggregated insight of gateways, applications and end devices.
post
/noc/application/{application_ids.application_id}/channels/lora-performance
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application_ids": {
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"channels": {
"items": {
"description": "LoRa performance per channel.",
"properties": {
"agg_lora_rssi": {
"additionalProperties": {
"format": "float",
"type": "number"
},
"description": "Aggregated observed LoRa RSSI (channel RSSI adjusted for SNR) per frequency (Hz).",
"type": "object"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/application/{application_ids.application_id}/channels/packet-count
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application_ids": {
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"channels": {
"items": {
"description": "Packet count per channel.",
"properties": {
"count": {
"additionalProperties": {
"format": "uint64",
"type": "string"
},
"description": "Packet counts per frequency (Hz).",
"type": "object"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/application/{application_ids.application_id}/channels/utilization
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application_ids": {
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"channels": {
"items": {
"description": "Utilization per channel.",
"properties": {
"time": {
"format": "date-time",
"type": "string"
},
"utilization": {
"additionalProperties": {
"format": "float",
"type": "number"
},
"description": "Utilization (fraction of time) per frequency (Hz) that the channel is in use.",
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/application/{application_ids.application_id}/data_rates/packet-count
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application_ids": {
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"data_rates": {
"items": {
"properties": {
"count": {
"additionalProperties": {
"format": "uint64",
"type": "string"
},
"description": "Packet counts per data rate.",
"type": "object"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/application/{application_ids.application_id}/end_devices/active-metrics
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application_ids": {
"type": "object"
},
"time_window": {
"description": "Request for data in a specific time window.",
"properties": {
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"end_device_ids": {
"items": {
"properties": {
"application_ids": {
"properties": {
"application_id": {
"type": "string"
}
},
"type": "object"
},
"dev_addr": {
"description": "The LoRaWAN DevAddr.",
"example": "2600ABCD",
"format": "string",
"type": "string"
},
"dev_eui": {
"description": "The LoRaWAN DevEUI.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"device_id": {
"type": "string"
},
"join_eui": {
"description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/application/{application_ids.application_id}/events/forward
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application_ids": {
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"event_forward_count": {
"items": {
"properties": {
"count": {
"additionalProperties": {
"format": "uint64",
"type": "string"
},
"description": "Application Server forwarded events count per event name.",
"type": "object"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/application/{application_ids.application_id}/events/webhook/failure
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application_ids": {
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"webhook_failure": {
"items": {
"properties": {
"time": {
"format": "date-time",
"type": "string"
},
"total": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/application/{application_ids.application_id}/events/webhook/failure/ratio
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application_ids": {
"type": "object"
},
"time_window": {
"description": "Request for data in a specific time window.",
"properties": {
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"webhook_failure_to_forward_ratio": {
"format": "float",
"type": "number"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/application/{application_ids.application_id}/events/webhook/failure/top-five
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application_ids": {
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"counts": {
"items": {
"properties": {
"time": {
"format": "date-time",
"type": "string"
},
"totals": {
"additionalProperties": {
"format": "uint64",
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/application/{application_ids.application_id}/gateways
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application_ids": {
"type": "object"
},
"time_window": {
"description": "Request for data in a specific time window.",
"properties": {
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"gateways": {
"items": {
"properties": {
"best_channel_rssi": {
"format": "float",
"type": "number"
},
"gateway_id": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"gateway_id": {
"type": "string"
}
},
"type": "object"
},
"packet_count": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/application/{application_ids.application_id}/statistics
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application_ids": {
"type": "object"
},
"time_window": {
"description": "Request for data in a specific time window.",
"properties": {
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"stats": {
"items": {
"description": "Application end devices statistic.",
"properties": {
"best_channel_rssi": {
"format": "float",
"type": "number"
},
"best_gateway_ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"gateway_id": {
"type": "string"
}
},
"type": "object"
},
"end_device_ids": {
"properties": {
"application_ids": {
"properties": {
"application_id": {
"type": "string"
}
},
"type": "object"
},
"dev_addr": {
"description": "The LoRaWAN DevAddr.",
"example": "2600ABCD",
"format": "string",
"type": "string"
},
"dev_eui": {
"description": "The LoRaWAN DevEUI.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"device_id": {
"type": "string"
},
"join_eui": {
"description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"last_packet_error_rate": {
"format": "float",
"type": "number"
},
"last_seen": {
"format": "date-time",
"type": "string"
},
"packet_count": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/applications/active
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"daily_buckets": {
"items": {
"description": "Number of entities connected in a time bucket.",
"properties": {
"count": {
"format": "int64",
"type": "integer"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hourly_buckets": {
"items": {
"description": "Number of entities connected in a time bucket.",
"properties": {
"count": {
"format": "int64",
"type": "integer"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"weekly_buckets": {
"items": {
"description": "Number of entities connected in a time bucket.",
"properties": {
"count": {
"format": "int64",
"type": "integer"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/applications/active-metrics
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"application_ids": {
"items": {
"properties": {
"application_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/applications/statistics
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"stats": {
"items": {
"description": "Applications statistic.",
"properties": {
"active_devices": {
"format": "int64",
"type": "integer"
},
"application_ids": {
"properties": {
"application_id": {
"type": "string"
}
},
"type": "object"
},
"average_packet_error_rate": {
"format": "float",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/noc/configuration
Get the configuration of the Network Operations Center.
The response is typically used to enable or disable features in a user interface.
Request Parameters
| Field | Type | Required | Description |
|---|
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"configuration": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/channels/lora-performance
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
end_device_ids.application_ids.application_id |
string | true | |
end_device_ids.device_id |
string | true |
Request Body
Show JSON Schema
{
"end_device_ids": {
"properties": {
"application_ids": {
"type": "object"
},
"dev_addr": {
"description": "The LoRaWAN DevAddr.",
"example": "2600ABCD",
"format": "string",
"type": "string"
},
"dev_eui": {
"description": "The LoRaWAN DevEUI.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"join_eui": {
"description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"channels": {
"items": {
"description": "LoRa performance per channel.",
"properties": {
"agg_lora_rssi": {
"additionalProperties": {
"format": "float",
"type": "number"
},
"description": "Aggregated observed LoRa RSSI (channel RSSI adjusted for SNR) per frequency (Hz).",
"type": "object"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/channels/packet-count
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
end_device_ids.application_ids.application_id |
string | true | |
end_device_ids.device_id |
string | true |
Request Body
Show JSON Schema
{
"end_device_ids": {
"properties": {
"application_ids": {
"type": "object"
},
"dev_addr": {
"description": "The LoRaWAN DevAddr.",
"example": "2600ABCD",
"format": "string",
"type": "string"
},
"dev_eui": {
"description": "The LoRaWAN DevEUI.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"join_eui": {
"description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"channels": {
"items": {
"description": "Packet count per channel.",
"properties": {
"count": {
"additionalProperties": {
"format": "uint64",
"type": "string"
},
"description": "Packet counts per frequency (Hz).",
"type": "object"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/channels/utilization
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
end_device_ids.application_ids.application_id |
string | true | |
end_device_ids.device_id |
string | true |
Request Body
Show JSON Schema
{
"end_device_ids": {
"properties": {
"application_ids": {
"type": "object"
},
"dev_addr": {
"description": "The LoRaWAN DevAddr.",
"example": "2600ABCD",
"format": "string",
"type": "string"
},
"dev_eui": {
"description": "The LoRaWAN DevEUI.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"join_eui": {
"description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"channels": {
"items": {
"description": "Utilization per channel.",
"properties": {
"time": {
"format": "date-time",
"type": "string"
},
"utilization": {
"additionalProperties": {
"format": "float",
"type": "number"
},
"description": "Utilization (fraction of time) per frequency (Hz) that the channel is in use.",
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/data_rates/packet-count
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
end_device_ids.application_ids.application_id |
string | true | |
end_device_ids.device_id |
string | true |
Request Body
Show JSON Schema
{
"end_device_ids": {
"properties": {
"application_ids": {
"type": "object"
},
"dev_addr": {
"description": "The LoRaWAN DevAddr.",
"example": "2600ABCD",
"format": "string",
"type": "string"
},
"dev_eui": {
"description": "The LoRaWAN DevEUI.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"join_eui": {
"description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"data_rates": {
"items": {
"properties": {
"count": {
"additionalProperties": {
"format": "uint64",
"type": "string"
},
"description": "Packet counts per data rate.",
"type": "object"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/last-seen
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
end_device_ids.application_ids.application_id |
string | true | |
end_device_ids.device_id |
string | true |
Request Body
Show JSON Schema
{
"end_device_ids": {
"properties": {
"application_ids": {
"type": "object"
},
"dev_addr": {
"description": "The LoRaWAN DevAddr.",
"example": "2600ABCD",
"format": "string",
"type": "string"
},
"dev_eui": {
"description": "The LoRaWAN DevEUI.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"join_eui": {
"description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. | None |
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/packet-error-rate
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
end_device_ids.application_ids.application_id |
string | true | |
end_device_ids.device_id |
string | true |
Request Body
Show JSON Schema
{
"end_device_ids": {
"properties": {
"application_ids": {
"type": "object"
},
"dev_addr": {
"description": "The LoRaWAN DevAddr.",
"example": "2600ABCD",
"format": "string",
"type": "string"
},
"dev_eui": {
"description": "The LoRaWAN DevEUI.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"join_eui": {
"description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"packet_error_rates": {
"items": {
"properties": {
"packet_error_rate": {
"format": "float",
"type": "number"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/session-start
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
end_device_ids.application_ids.application_id |
string | true | |
end_device_ids.device_id |
string | true |
Request Body
Show JSON Schema
{
"end_device_ids": {
"properties": {
"application_ids": {
"type": "object"
},
"dev_addr": {
"description": "The LoRaWAN DevAddr.",
"example": "2600ABCD",
"format": "string",
"type": "string"
},
"dev_eui": {
"description": "The LoRaWAN DevEUI.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"join_eui": {
"description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. | None |
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/end_devices/active
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"daily_buckets": {
"items": {
"description": "Number of entities connected in a time bucket.",
"properties": {
"count": {
"format": "int64",
"type": "integer"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hourly_buckets": {
"items": {
"description": "Number of entities connected in a time bucket.",
"properties": {
"count": {
"format": "int64",
"type": "integer"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"weekly_buckets": {
"items": {
"description": "Number of entities connected in a time bucket.",
"properties": {
"count": {
"format": "int64",
"type": "integer"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/end_devices/active-metrics
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"end_device_ids": {
"items": {
"properties": {
"application_ids": {
"properties": {
"application_id": {
"type": "string"
}
},
"type": "object"
},
"dev_addr": {
"description": "The LoRaWAN DevAddr.",
"example": "2600ABCD",
"format": "string",
"type": "string"
},
"dev_eui": {
"description": "The LoRaWAN DevEUI.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"device_id": {
"type": "string"
},
"join_eui": {
"description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/end_devices/statistics
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"stats": {
"items": {
"description": "End devices statistic.",
"properties": {
"application_ids": {
"properties": {
"application_id": {
"type": "string"
}
},
"type": "object"
},
"end_device_ids": {
"properties": {
"application_ids": {
"properties": {
"application_id": {
"type": "string"
}
},
"type": "object"
},
"dev_addr": {
"description": "The LoRaWAN DevAddr.",
"example": "2600ABCD",
"format": "string",
"type": "string"
},
"dev_eui": {
"description": "The LoRaWAN DevEUI.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"device_id": {
"type": "string"
},
"join_eui": {
"description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"last_packet_error_rate": {
"format": "float",
"type": "number"
},
"last_seen": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateway/{gateway_ids.gateway_id}/channels/lora-performance
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
gateway_ids.gateway_id |
string | true |
Request Body
Show JSON Schema
{
"gateway_ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"channels": {
"items": {
"description": "LoRa performance per channel.",
"properties": {
"agg_lora_rssi": {
"additionalProperties": {
"format": "float",
"type": "number"
},
"description": "Aggregated observed LoRa RSSI (channel RSSI adjusted for SNR) per frequency (Hz).",
"type": "object"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateway/{gateway_ids.gateway_id}/channels/packet-count
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
gateway_ids.gateway_id |
string | true |
Request Body
Show JSON Schema
{
"gateway_ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"channels": {
"items": {
"description": "Packet count per channel.",
"properties": {
"count": {
"additionalProperties": {
"format": "uint64",
"type": "string"
},
"description": "Packet counts per frequency (Hz).",
"type": "object"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateway/{gateway_ids.gateway_id}/channels/utilization
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
gateway_ids.gateway_id |
string | true |
Request Body
Show JSON Schema
{
"gateway_ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"channels": {
"items": {
"description": "Utilization per channel.",
"properties": {
"time": {
"format": "date-time",
"type": "string"
},
"utilization": {
"additionalProperties": {
"format": "float",
"type": "number"
},
"description": "Utilization (fraction of time) per frequency (Hz) that the channel is in use.",
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateway/{gateway_ids.gateway_id}/data_rates/packet-count
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
gateway_ids.gateway_id |
string | true |
Request Body
Show JSON Schema
{
"gateway_ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"data_rates": {
"items": {
"properties": {
"count": {
"additionalProperties": {
"format": "uint64",
"type": "string"
},
"description": "Packet counts per data rate.",
"type": "object"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateway/{gateway_ids.gateway_id}/rtt
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
gateway_ids.gateway_id |
string | true |
Request Body
Show JSON Schema
{
"gateway_ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"stats": {
"items": {
"description": "Gateway RTT statistic.",
"properties": {
"max": {
"type": "string"
},
"median": {
"type": "string"
},
"min": {
"type": "string"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateway/{gateway_ids.gateway_id}/traffic
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
gateway_ids.gateway_id |
string | true |
Request Body
Show JSON Schema
{
"gateway_ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_bucket": {
"description": "Request for data using aggregates by time buckets with a specified interval.",
"properties": {
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"downlink": {
"items": {
"properties": {
"rate": {
"format": "float",
"type": "number"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"uplink": {
"items": {
"properties": {
"rate": {
"format": "float",
"type": "number"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateway/{gateway_ids.gateway_id}/uptime
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
gateway_ids.gateway_id |
string | true |
Request Body
Show JSON Schema
{
"gateway_ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_window": {
"description": "Request for data in a specific time window.",
"properties": {
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. | None |
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateway/{gateway_time_window.gateway_ids.gateway_id}/connection-events
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
gateway_time_window.gateway_ids.gateway_id |
string | true |
Request Body
Show JSON Schema
{
"event_type": {
"properties": {
"value": {
"default": "GATEWAY_CONNECTION_EVENT_TYPE_CONNECT",
"description": "Gateway connection event type.\n\n - GATEWAY_CONNECTION_EVENT_TYPE_CONNECT: The gateway connects.\n - GATEWAY_CONNECTION_EVENT_TYPE_DISCONNECT: The gateway disconnects.\n - GATEWAY_CONNECTION_EVENT_TYPE_STATS: The gateway connection statistics are updated.",
"enum": [
"GATEWAY_CONNECTION_EVENT_TYPE_CONNECT",
"GATEWAY_CONNECTION_EVENT_TYPE_DISCONNECT",
"GATEWAY_CONNECTION_EVENT_TYPE_STATS"
],
"type": "string"
}
},
"type": "object"
},
"gateway_time_window": {
"description": "Request for gateway data in a specific time window.",
"properties": {
"gateway_ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_window": {
"description": "Request for data in a specific time window.",
"properties": {
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"events": {
"items": {
"description": "Gateway connection event.",
"properties": {
"event_type": {
"default": "GATEWAY_CONNECTION_EVENT_TYPE_CONNECT",
"description": "Gateway connection event type.\n\n - GATEWAY_CONNECTION_EVENT_TYPE_CONNECT: The gateway connects.\n - GATEWAY_CONNECTION_EVENT_TYPE_DISCONNECT: The gateway disconnects.\n - GATEWAY_CONNECTION_EVENT_TYPE_STATS: The gateway connection statistics are updated.",
"enum": [
"GATEWAY_CONNECTION_EVENT_TYPE_CONNECT",
"GATEWAY_CONNECTION_EVENT_TYPE_DISCONNECT",
"GATEWAY_CONNECTION_EVENT_TYPE_STATS"
],
"type": "string"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateway/{gateway_time_window.gateway_ids.gateway_id}/networks-seen/top/{top}
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
gateway_time_window.gateway_ids.gateway_id |
string | true | |
top |
integer | true | Top number of networks to include. |
Request Body
Show JSON Schema
{
"gateway_time_window": {
"description": "Request for gateway data in a specific time window.",
"properties": {
"gateway_ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"time_window": {
"description": "Request for data in a specific time window.",
"properties": {
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"networks": {
"additionalProperties": {
"format": "float",
"type": "number"
},
"description": "Proportion of network by name. The proportions are a fraction of 1. The remaining number is the rest total.",
"type": "object"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateways/active-metrics
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"gateway_ids": {
"items": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"gateway_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateways/connected
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"bucket_interval": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"daily_buckets": {
"items": {
"description": "Number of entities connected in a time bucket.",
"properties": {
"count": {
"format": "int64",
"type": "integer"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hourly_buckets": {
"items": {
"description": "Number of entities connected in a time bucket.",
"properties": {
"count": {
"format": "int64",
"type": "integer"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"weekly_buckets": {
"items": {
"description": "Number of entities connected in a time bucket.",
"properties": {
"count": {
"format": "int64",
"type": "integer"
},
"time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/noc/gateways/connectivity
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"gateways": {
"items": {
"description": "Connectivity times of a gateway.",
"properties": {
"disconnects": {
"description": "Number of disconnects.",
"format": "uint64",
"type": "string"
},
"gateway_ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"gateway_id": {
"type": "string"
}
},
"type": "object"
},
"last_connect": {
"format": "date-time",
"type": "string"
},
"last_disconnect": {
"format": "date-time",
"type": "string"
},
"packet_rate_last_hour": {
"description": "Packet rate (uplink and downlink) of the last hour.",
"format": "float",
"type": "number"
},
"uptime": {
"description": "Fraction of time that the gateway was active.\nThis is typically aggregated in time buckets of at least 5 minutes or 1 hour depending on the query window.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/noc/health
Request Parameters
| Field | Type | Required | Description |
|---|
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. | None |
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
EntityRegistrySearch
Search for entities in the Entity Registry.
get
/applications/{application_ids.application_id}/collaborators/search
Search for accounts that match the conditions specified in the request.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true | |
query |
string | ||
only_users |
boolean | ||
client_ids.client_id |
string | ||
gateway_ids.gateway_id |
string | ||
gateway_ids.eui |
string | Secondary identifier, which can only be used in specific requests. | |
organization_ids.organization_id |
string | This ID shares namespace with user IDs. | |
complement_collaborators |
boolean |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"account_ids": {
"items": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/clients/{client_ids.client_id}/collaborators/search
Search for accounts that match the conditions specified in the request.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
client_ids.client_id |
string | true | |
query |
string | ||
only_users |
boolean | ||
application_ids.application_id |
string | ||
gateway_ids.gateway_id |
string | ||
gateway_ids.eui |
string | Secondary identifier, which can only be used in specific requests. | |
organization_ids.organization_id |
string | This ID shares namespace with user IDs. | |
complement_collaborators |
boolean |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"account_ids": {
"items": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/gateways/{gateway_ids.gateway_id}/collaborators/search
Search for accounts that match the conditions specified in the request.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
gateway_ids.gateway_id |
string | true | |
query |
string | ||
only_users |
boolean | ||
application_ids.application_id |
string | ||
client_ids.client_id |
string | ||
gateway_ids.eui |
string | Secondary identifier, which can only be used in specific requests. | |
organization_ids.organization_id |
string | This ID shares namespace with user IDs. | |
complement_collaborators |
boolean |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"account_ids": {
"items": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/organizations/{organization_ids.organization_id}/collaborators/search
Search for accounts that match the conditions specified in the request.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
organization_ids.organization_id |
string | true | This ID shares namespace with user IDs. |
query |
string | ||
only_users |
boolean | ||
application_ids.application_id |
string | ||
client_ids.client_id |
string | ||
gateway_ids.gateway_id |
string | ||
gateway_ids.eui |
string | Secondary identifier, which can only be used in specific requests. | |
complement_collaborators |
boolean |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"account_ids": {
"items": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/search/accounts
Search for accounts that match the conditions specified in the request.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
query |
string | ||
only_users |
boolean | ||
application_ids.application_id |
string | ||
client_ids.client_id |
string | ||
gateway_ids.gateway_id |
string | ||
gateway_ids.eui |
string | Secondary identifier, which can only be used in specific requests. | |
organization_ids.organization_id |
string | This ID shares namespace with user IDs. | |
complement_collaborators |
boolean |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"account_ids": {
"items": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/search/applications
Search for applications that match the conditions specified in the request.
Non-admin users will only match applications that they have rights on.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
query |
string | Find applications where the ID, name or description contains this substring. | |
id_contains |
string | Find applications where the ID contains this substring. | |
name_contains |
string | Find applications where the name contains this substring. | |
description_contains |
string | Find applications where the description contains this substring. | |
attributes_contain[string] |
string | This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18 | |
field_mask |
string | ||
order |
string | Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. | |
limit |
integer | Limit the number of results per page. | |
page |
integer | Page number for pagination. 0 is interpreted as 1. | |
deleted |
boolean | Only return recently deleted applications. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"applications": {
"items": {
"description": "Application is the message that defines an Application in the network.",
"properties": {
"administrative_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"application_server_address": {
"description": "The address of the Application Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Key-value attributes for this application. Typically used for organizing applications or for storing integration-specific data.",
"type": "object"
},
"contact_info": {
"description": "Contact information for this application. Typically used to indicate who to contact with technical/security questions about the application.\nThis field is deprecated. Use administrative_contact and technical_contact instead.",
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"description": "When the application was created. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"deleted_at": {
"description": "When the application was deleted. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"description": {
"description": "A description for the application.",
"type": "string"
},
"dev_eui_counter": {
"format": "int64",
"type": "integer"
},
"end_device_limit": {
"description": "The limit of the number of end devices that can be registered for this application.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"ids": {
"properties": {
"application_id": {
"type": "string"
}
},
"type": "object"
},
"join_server_address": {
"description": "The address of the Join Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"network_server_address": {
"description": "The address of the Network Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"technical_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"updated_at": {
"description": "When the application was last updated. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/search/clients
Search for OAuth clients that match the conditions specified in the request.
Non-admin users will only match OAuth clients that they have rights on.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
query |
string | Find OAuth clients where the ID, name or description contains this substring. | |
id_contains |
string | Find OAuth clients where the ID contains this substring. | |
name_contains |
string | Find OAuth clients where the name contains this substring. | |
description_contains |
string | Find OAuth clients where the description contains this substring. | |
attributes_contain[string] |
string | This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18 | |
state |
array | Find OAuth clients where the state is any of these states. - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin. - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin. - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin. - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin. - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin. | |
field_mask |
string | ||
order |
string | Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. | |
limit |
integer | Limit the number of results per page. | |
page |
integer | Page number for pagination. 0 is interpreted as 1. | |
deleted |
boolean | Only return recently deleted OAuth clients. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"clients": {
"items": {
"description": "An OAuth client on the network.",
"properties": {
"administrative_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Key-value attributes for this client. Typically used for organizing clients or for storing integration-specific data.",
"type": "object"
},
"contact_info": {
"description": "Contact information for this client. Typically used to indicate who to contact with technical/security questions about the application.\nThis information is public and can be seen by any authenticated user in the network.\nThis field is deprecated. Use administrative_contact and technical_contact instead.",
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"description": "When the OAuth client was created. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"deleted_at": {
"description": "When the OAuth client was deleted. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"description": {
"description": "A description for the OAuth client. This information is public and can be seen by any authenticated user in the network.",
"type": "string"
},
"endorsed": {
"description": "If set, the authorization page will show endorsement.\nThis information is public and can be seen by any authenticated user in the network.\nThis field can only be modified by admins.",
"type": "boolean"
},
"grants": {
"description": "OAuth flows that can be used for the client to get a token.\nThis information is public and can be seen by any authenticated user in the network.\nAfter a client is created, this field can only be modified by admins.",
"items": {
"default": "GRANT_AUTHORIZATION_CODE",
"description": "The OAuth2 flows an OAuth client can use to get an access token.\n\n - GRANT_AUTHORIZATION_CODE: Grant type used to exchange an authorization code for an access token.\n - GRANT_PASSWORD: Grant type used to exchange a user ID and password for an access token.\n - GRANT_REFRESH_TOKEN: Grant type used to exchange a refresh token for an access token.",
"enum": [
"GRANT_AUTHORIZATION_CODE",
"GRANT_PASSWORD",
"GRANT_REFRESH_TOKEN"
],
"type": "string"
},
"type": "array"
},
"ids": {
"properties": {
"client_id": {
"type": "string"
}
},
"type": "object"
},
"logout_redirect_uris": {
"description": "The allowed logout redirect URIs against which client initiated logout\nrequests are checked. If the authorization request does not pass a redirect\nURI, the first one from this list is taken.\nThis information is public and can be seen by any authenticated user in the network.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the OAuth client. This information is public and can be seen by any authenticated user in the network.",
"type": "string"
},
"redirect_uris": {
"description": "The allowed redirect URIs against which authorization requests are checked.\nIf the authorization request does not pass a redirect URI, the first one\nfrom this list is taken.\nThis information is public and can be seen by any authenticated user in the network.",
"items": {
"type": "string"
},
"type": "array"
},
"rights": {
"description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.",
"items": {
"default": "right_invalid",
"description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.",
"enum": [
"right_invalid",
"RIGHT_USER_INFO",
"RIGHT_USER_SETTINGS_BASIC",
"RIGHT_USER_SETTINGS_API_KEYS",
"RIGHT_USER_DELETE",
"RIGHT_USER_AUTHORIZED_CLIENTS",
"RIGHT_USER_APPLICATIONS_LIST",
"RIGHT_USER_APPLICATIONS_CREATE",
"RIGHT_USER_GATEWAYS_LIST",
"RIGHT_USER_GATEWAYS_CREATE",
"RIGHT_USER_CLIENTS_LIST",
"RIGHT_USER_CLIENTS_CREATE",
"RIGHT_USER_ORGANIZATIONS_LIST",
"RIGHT_USER_ORGANIZATIONS_CREATE",
"RIGHT_USER_NOTIFICATIONS_READ",
"RIGHT_USER_ALL",
"RIGHT_APPLICATION_INFO",
"RIGHT_APPLICATION_SETTINGS_BASIC",
"RIGHT_APPLICATION_SETTINGS_API_KEYS",
"RIGHT_APPLICATION_SETTINGS_COLLABORATORS",
"RIGHT_APPLICATION_SETTINGS_PACKAGES",
"RIGHT_APPLICATION_DELETE",
"RIGHT_APPLICATION_DEVICES_READ",
"RIGHT_APPLICATION_DEVICES_WRITE",
"RIGHT_APPLICATION_DEVICES_READ_KEYS",
"RIGHT_APPLICATION_DEVICES_WRITE_KEYS",
"RIGHT_APPLICATION_TRAFFIC_READ",
"RIGHT_APPLICATION_TRAFFIC_UP_WRITE",
"RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE",
"RIGHT_APPLICATION_LINK",
"RIGHT_APPLICATION_ALL",
"RIGHT_CLIENT_ALL",
"RIGHT_CLIENT_INFO",
"RIGHT_CLIENT_SETTINGS_BASIC",
"RIGHT_CLIENT_SETTINGS_COLLABORATORS",
"RIGHT_CLIENT_DELETE",
"RIGHT_GATEWAY_INFO",
"RIGHT_GATEWAY_SETTINGS_BASIC",
"RIGHT_GATEWAY_SETTINGS_API_KEYS",
"RIGHT_GATEWAY_SETTINGS_COLLABORATORS",
"RIGHT_GATEWAY_DELETE",
"RIGHT_GATEWAY_TRAFFIC_READ",
"RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE",
"RIGHT_GATEWAY_LINK",
"RIGHT_GATEWAY_STATUS_READ",
"RIGHT_GATEWAY_LOCATION_READ",
"RIGHT_GATEWAY_WRITE_SECRETS",
"RIGHT_GATEWAY_READ_SECRETS",
"RIGHT_GATEWAY_ALL",
"RIGHT_ORGANIZATION_INFO",
"RIGHT_ORGANIZATION_SETTINGS_BASIC",
"RIGHT_ORGANIZATION_SETTINGS_API_KEYS",
"RIGHT_ORGANIZATION_SETTINGS_MEMBERS",
"RIGHT_ORGANIZATION_DELETE",
"RIGHT_ORGANIZATION_APPLICATIONS_LIST",
"RIGHT_ORGANIZATION_APPLICATIONS_CREATE",
"RIGHT_ORGANIZATION_GATEWAYS_LIST",
"RIGHT_ORGANIZATION_GATEWAYS_CREATE",
"RIGHT_ORGANIZATION_CLIENTS_LIST",
"RIGHT_ORGANIZATION_CLIENTS_CREATE",
"RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR",
"RIGHT_ORGANIZATION_ALL",
"RIGHT_SEND_INVITES",
"RIGHT_ALL"
],
"type": "string"
},
"type": "array"
},
"secret": {
"description": "The client secret is only visible to collaborators of the client.",
"type": "string"
},
"skip_authorization": {
"description": "If set, the authorization page will be skipped.\nThis information is public and can be seen by any authenticated user in the network.\nThis field can only be modified by admins.",
"type": "boolean"
},
"state": {
"default": "STATE_REQUESTED",
"description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.",
"enum": [
"STATE_REQUESTED",
"STATE_APPROVED",
"STATE_REJECTED",
"STATE_FLAGGED",
"STATE_SUSPENDED"
],
"type": "string"
},
"state_description": {
"description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.",
"type": "string"
},
"technical_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"updated_at": {
"description": "When the OAuth client was last updated. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/search/gateways
Search for gateways that match the conditions specified in the request.
Non-admin users will only match gateways that they have rights on.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
query |
string | Find gateways where the ID, name, description or EUI contains this substring. | |
id_contains |
string | Find gateways where the ID contains this substring. | |
name_contains |
string | Find gateways where the name contains this substring. | |
description_contains |
string | Find gateways where the description contains this substring. | |
attributes_contain[string] |
string | This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18 | |
eui_contains |
string | Find gateways where the (hexadecimal) EUI contains this substring. | |
field_mask |
string | ||
order |
string | Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. | |
limit |
integer | Limit the number of results per page. | |
page |
integer | Page number for pagination. 0 is interpreted as 1. | |
deleted |
boolean | Only return recently deleted gateways. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"gateways": {
"items": {
"description": "Gateway is the message that defines a gateway on the network.",
"properties": {
"administrative_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"alert_notification_profile_ids": {
"properties": {
"profile_id": {
"type": "string"
}
},
"type": "object"
},
"antennas": {
"description": "Antennas of the gateway. Location information of the antennas is public and can be seen by any authenticated user in the network if location_public=true.",
"items": {
"description": "GatewayAntenna is the message that defines a gateway antenna.",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"gain": {
"description": "Antenna gain relative to the gateway, in dBi.",
"format": "float",
"type": "number"
},
"location": {
"properties": {
"accuracy": {
"description": "The accuracy of the location (meters).",
"format": "int32",
"type": "integer"
},
"altitude": {
"description": "The altitude (meters), where 0 is the mean sea level.",
"format": "int32",
"type": "integer"
},
"latitude": {
"description": "The North–South position (degrees; -90 to +90), where 0 is the equator, North pole is positive, South pole is negative.",
"format": "double",
"type": "number"
},
"longitude": {
"description": "The East-West position (degrees; -180 to +180), where 0 is the Prime Meridian (Greenwich), East is positive , West is negative.",
"format": "double",
"type": "number"
},
"source": {
"default": "SOURCE_UNKNOWN",
"description": " - SOURCE_UNKNOWN: The source of the location is not known or not set.\n - SOURCE_GPS: The location is determined by GPS.\n - SOURCE_REGISTRY: The location is set in and updated from a registry.\n - SOURCE_IP_GEOLOCATION: The location is estimated with IP geolocation.\n - SOURCE_WIFI_RSSI_GEOLOCATION: The location is estimated with WiFi RSSI geolocation.\n - SOURCE_BT_RSSI_GEOLOCATION: The location is estimated with BT/BLE RSSI geolocation.\n - SOURCE_LORA_RSSI_GEOLOCATION: The location is estimated with LoRa RSSI geolocation.\n - SOURCE_LORA_TDOA_GEOLOCATION: The location is estimated with LoRa TDOA geolocation.\n - SOURCE_COMBINED_GEOLOCATION: The location is estimated by a combination of geolocation sources.\n\nMore estimation methods can be added.",
"enum": [
"SOURCE_UNKNOWN",
"SOURCE_GPS",
"SOURCE_REGISTRY",
"SOURCE_IP_GEOLOCATION",
"SOURCE_WIFI_RSSI_GEOLOCATION",
"SOURCE_BT_RSSI_GEOLOCATION",
"SOURCE_LORA_RSSI_GEOLOCATION",
"SOURCE_LORA_TDOA_GEOLOCATION",
"SOURCE_COMBINED_GEOLOCATION"
],
"type": "string"
}
},
"type": "object"
},
"placement": {
"default": "PLACEMENT_UNKNOWN",
"enum": [
"PLACEMENT_UNKNOWN",
"INDOOR",
"OUTDOOR"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Key-value attributes for this gateway. Typically used for organizing gateways or for storing integration-specific data.",
"type": "object"
},
"auto_update": {
"type": "boolean"
},
"claim_authentication_code": {
"description": "Authentication code for claiming gateways.",
"properties": {
"secret": {
"description": "Secret contains a secret value. It also contains the ID of the Encryption key used to encrypt it.",
"properties": {
"key_id": {
"description": "ID of the Key used to encrypt the secret.",
"type": "string"
},
"value": {
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"contact_info": {
"description": "Contact information for this gateway. Typically used to indicate who to contact with technical/security questions about the gateway.\nThis field is deprecated. Use administrative_contact and technical_contact instead.",
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"description": "When the gateway was created. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"deleted_at": {
"description": "When the gateway was deleted. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"description": {
"description": "A description for the gateway. This information is public and can be seen by any authenticated user in the network.",
"type": "string"
},
"disable_packet_broker_forwarding": {
"type": "boolean"
},
"downlink_path_constraint": {
"default": "DOWNLINK_PATH_CONSTRAINT_NONE",
"description": " - DOWNLINK_PATH_CONSTRAINT_NONE: Indicates that the gateway can be selected for downlink without constraints by the Network Server.\n - DOWNLINK_PATH_CONSTRAINT_PREFER_OTHER: Indicates that the gateway can be selected for downlink only if no other or better gateway can be selected.\n - DOWNLINK_PATH_CONSTRAINT_NEVER: Indicates that this gateway will never be selected for downlink, even if that results in no available downlink path.",
"enum": [
"DOWNLINK_PATH_CONSTRAINT_NONE",
"DOWNLINK_PATH_CONSTRAINT_PREFER_OTHER",
"DOWNLINK_PATH_CONSTRAINT_NEVER"
],
"type": "string"
},
"enforce_duty_cycle": {
"description": "Enforcing gateway duty cycle is recommended for all gateways to respect spectrum regulations. Disable enforcing the\nduty cycle only in controlled research and development environments.",
"type": "boolean"
},
"frequency_plan_id": {
"description": "Frequency plan ID of the gateway.\nThis information is public and can be seen by any authenticated user in the network.\nDEPRECATED: use frequency_plan_ids.\nThis equals the first element of the frequency_plan_ids field.",
"type": "string"
},
"frequency_plan_ids": {
"description": "Frequency plan IDs of the gateway.\nThis information is public and can be seen by any authenticated user in the network.\nThe first element equals the frequency_plan_id field.",
"items": {
"type": "string"
},
"type": "array"
},
"gateway_server_address": {
"description": "The address of the Gateway Server to connect to.\nThis information is public and can be seen by any authenticated user in the network if status_public is true.\nThe typical format of the address is \"scheme://host:port\". The scheme is optional. If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"ids": {
"properties": {
"eui": {
"description": "Secondary identifier, which can only be used in specific requests.",
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
},
"gateway_id": {
"type": "string"
}
},
"type": "object"
},
"lbs_lns_secret": {
"description": "Secret contains a secret value. It also contains the ID of the Encryption key used to encrypt it.",
"properties": {
"key_id": {
"description": "ID of the Key used to encrypt the secret.",
"type": "string"
},
"value": {
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"location_public": {
"description": "The location of this gateway may be publicly displayed.",
"type": "boolean"
},
"lrfhss": {
"description": "LR-FHSS gateway capabilities.",
"properties": {
"supported": {
"description": "The gateway supports the LR-FHSS uplink channels.",
"type": "boolean"
}
},
"type": "object"
},
"name": {
"description": "The name of the gateway. This information is public and can be seen by any authenticated user in the network.",
"type": "string"
},
"require_authenticated_connection": {
"description": "Require an authenticated gateway connection. This prevents the gateway from using the UDP protocol and requires authentication when using other protocols.",
"type": "boolean"
},
"schedule_anytime_delay": {
"description": "Adjust the time that GS schedules class C messages in advance. This is useful for gateways that have a known high latency backhaul, like 3G and satellite.",
"type": "string"
},
"schedule_downlink_late": {
"description": "Enable server-side buffering of downlink messages. This is recommended for gateways using the Semtech UDP Packet\nForwarder v2.x or older, as it does not feature a just-in-time queue. If enabled, the Gateway Server schedules the\ndownlink message late to the gateway so that it does not overwrite previously scheduled downlink messages that have\nnot been transmitted yet.",
"type": "boolean"
},
"status_public": {
"description": "The status of this gateway may be publicly displayed.",
"type": "boolean"
},
"target_cups_key": {
"description": "Secret contains a secret value. It also contains the ID of the Encryption key used to encrypt it.",
"properties": {
"key_id": {
"description": "ID of the Key used to encrypt the secret.",
"type": "string"
},
"value": {
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"target_cups_uri": {
"description": "CUPS URI for LoRa Basics Station CUPS redirection.\nThe CUPS Trust field will be automatically fetched from the cert chain presented by the target server.",
"type": "string"
},
"technical_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"update_channel": {
"type": "string"
},
"update_location_from_status": {
"description": "Update the location of this gateway from status messages. This only works for gateways connecting with authentication; gateways connected over UDP are not supported.",
"type": "boolean"
},
"updated_at": {
"description": "When the gateway was last updated. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"version_ids": {
"description": "Identifies an end device model with version information.",
"properties": {
"brand_id": {
"type": "string"
},
"firmware_version": {
"type": "string"
},
"hardware_version": {
"type": "string"
},
"model_id": {
"type": "string"
},
"runtime_version": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/search/organizations
Search for organizations that match the conditions specified in the request.
Non-admin users will only match organizations that they have rights on.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
query |
string | Find organizations where the ID, name or description contains this substring. | |
id_contains |
string | Find organizations where the ID contains this substring. | |
name_contains |
string | Find organizations where the name contains this substring. | |
description_contains |
string | Find organizations where the description contains this substring. | |
attributes_contain[string] |
string | This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18 | |
field_mask |
string | ||
order |
string | Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. | |
limit |
integer | Limit the number of results per page. | |
page |
integer | Page number for pagination. 0 is interpreted as 1. | |
deleted |
boolean | Only return recently deleted organizations. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"organizations": {
"items": {
"properties": {
"administrative_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"application_limit": {
"description": "The maximum number of applications of the organization.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Key-value attributes for this organization. Typically used for organizing organizations or for storing integration-specific data.",
"type": "object"
},
"client_limit": {
"description": "The maximum number of clients of the organization.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"contact_info": {
"description": "Contact information for this organization. Typically used to indicate who to contact with security/billing questions about the organization.\nThis field is deprecated. Use administrative_contact and technical_contact instead.",
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"description": "When the organization was created. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"deleted_at": {
"description": "When the organization was deleted. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"description": {
"description": "A description for the organization.",
"type": "string"
},
"fanout_notifications": {
"description": "Determines if a notification will be sent to the collaborators. If false it, notifications will be sent only to the\nadministrative or technical contact.",
"type": "boolean"
},
"gateway_limit": {
"description": "The maximum number of gateways of the organization.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "The name of the organization. This information is public and can be seen by any authenticated user in the network.",
"type": "string"
},
"technical_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"updated_at": {
"description": "When the organization was last updated. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/search/tenants
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
id_contains |
string | Find tenants where the ID contains this substring. | |
name_contains |
string | Find tenants where the name contains this substring. | |
description_contains |
string | Find tenants where the description contains this substring. | |
attributes_contain[string] |
string | This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18 | |
state |
array | Find tenants where the state is any of these states. - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin. - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin. - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin. - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin. - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin. | |
field_mask |
string | ||
order |
string | Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. | |
limit |
integer | Limit the number of results per page. | |
page |
integer | Page number for pagination. 0 is interpreted as 1. | |
deleted |
boolean | Only return recently deleted tenants. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"tenants": {
"items": {
"description": "Tenant is the message that defines a Tenant in the network.",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"billing": {
"properties": {
"aws_saas_marketplace": {
"properties": {
"customer_identifier": {
"type": "string"
},
"product_code": {
"type": "string"
}
},
"type": "object"
},
"counting": {
"properties": {
"end_devices": {
"default": "ALL",
"enum": [
"ALL",
"ONLY_ACTIVATED"
],
"type": "string"
}
},
"type": "object"
},
"stripe": {
"properties": {
"customer_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"subscription_id": {
"type": "string"
},
"subscription_item_id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"billing_identifiers": {
"properties": {
"billing_id": {
"type": "string"
}
},
"type": "object"
},
"capabilities": {
"type": "object"
},
"configuration": {
"properties": {
"clusters": {
"additionalProperties": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Configuration per cluster (by ID).",
"type": "object"
},
"default_cluster": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"pb": {
"properties": {
"listed": {
"description": "Indicates whether the Home Network is publicly listed.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"contact_info": {
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"tenant_id": {
"type": "string"
}
},
"type": "object"
},
"max_applications": {
"description": "If set, restricts the maximum number of applications that can be created.",
"format": "uint64",
"type": "string"
},
"max_clients": {
"description": "If set, restricts the maximum number of clients that can be created.",
"format": "uint64",
"type": "string"
},
"max_end_devices": {
"description": "If set, restricts the maximum number of end_devices that can be created.",
"format": "uint64",
"type": "string"
},
"max_gateways": {
"description": "If set, restricts the maximum number of gateways that can be created.",
"format": "uint64",
"type": "string"
},
"max_organizations": {
"description": "If set, restricts the maximum number of organizations that can be created.",
"format": "uint64",
"type": "string"
},
"max_users": {
"description": "If set, restricts the maximum number of users that can be created.",
"format": "uint64",
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"default": "STATE_REQUESTED",
"description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.",
"enum": [
"STATE_REQUESTED",
"STATE_APPROVED",
"STATE_REJECTED",
"STATE_FLAGGED",
"STATE_SUSPENDED"
],
"type": "string"
},
"state_description": {
"description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/search/users
Search for users that match the conditions specified in the request.
This is only available to admin users.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
query |
string | Find users where the ID, name or description contains this substring. | |
id_contains |
string | Find users where the ID contains this substring. | |
name_contains |
string | Find users where the name contains this substring. | |
description_contains |
string | Find users where the description contains this substring. | |
attributes_contain[string] |
string | This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18 | |
state |
array | Find users where the state is any of these states. - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin. - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin. - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin. - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin. - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin. | |
field_mask |
string | ||
order |
string | Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. | |
limit |
integer | Limit the number of results per page. | |
page |
integer | Page number for pagination. 0 is interpreted as 1. | |
deleted |
boolean | Only return recently deleted users. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"users": {
"items": {
"description": "User is the message that defines a user on the network.",
"properties": {
"admin": {
"description": "This user is an admin.\nThis information is public and can be seen by any authenticated user in the network.\nThis field can only be modified by other admins.",
"type": "boolean"
},
"application_limit": {
"description": "The maximum number of applications of the user.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Key-value attributes for this users. Typically used for storing integration-specific data.",
"type": "object"
},
"client_limit": {
"description": "The maximum number of clients of the user.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"console_preferences": {
"description": "UserConsolePreferences is the message that defines the user preferences for the Console.",
"properties": {
"console_theme": {
"default": "CONSOLE_THEME_SYSTEM",
"description": "ConsoleTheme is the theme of the Console.\n\n - CONSOLE_THEME_SYSTEM: The user prefers the system mode.\n - CONSOLE_THEME_LIGHT: The user prefers the light mode.\n - CONSOLE_THEME_DARK: The user prefers the dark mode.",
"enum": [
"CONSOLE_THEME_SYSTEM",
"CONSOLE_THEME_LIGHT",
"CONSOLE_THEME_DARK"
],
"type": "string"
},
"dashboard_layouts": {
"properties": {
"api_key": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"application": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"collaborator": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"end_device": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"gateway": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"organization": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"overview": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"user": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
}
},
"type": "object"
},
"sort_by": {
"description": "SortBy defines the field to which the Console will sort the display of entities.",
"properties": {
"api_key": {
"type": "string"
},
"application": {
"type": "string"
},
"collaborator": {
"type": "string"
},
"end_device": {
"type": "string"
},
"gateway": {
"type": "string"
},
"organization": {
"type": "string"
},
"user": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"contact_info": {
"description": "Contact information for this user. Typically used to indicate who to contact with security/billing questions about the user.\nThis field is deprecated.",
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"description": "When the user was created. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"deleted_at": {
"description": "When the user was deleted. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"description": {
"description": "A description for the user. This information is public and can be seen by any authenticated user in the network.",
"type": "string"
},
"gateway_limit": {
"description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "The name of the user. This information is public and can be seen by any authenticated user in the network.",
"type": "string"
},
"organization_limit": {
"description": "The maximum number of organizations of the user.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"password": {
"description": "The password field is only considered when creating a user.\nIt is not returned on API calls, and can not be updated by updating the User.\nSee the UpdatePassword method of the UserRegistry service for more information.",
"type": "string"
},
"password_updated_at": {
"format": "date-time",
"type": "string"
},
"primary_email_address": {
"description": "Primary email address that can be used for logging in.\nThis address is not public, use contact_info for that.",
"type": "string"
},
"primary_email_address_validated_at": {
"description": "When the primary email address was validated. Note that email address validation is not required on all networks.",
"format": "date-time",
"type": "string"
},
"profile_picture": {
"properties": {
"embedded": {
"properties": {
"data": {
"description": "Picture data. A data URI can be constructed as follows:\n`data:\u003cmime_type\u003e;base64,\u003cdata\u003e`.",
"format": "byte",
"type": "string"
},
"mime_type": {
"description": "MIME type of the picture.",
"type": "string"
}
},
"type": "object"
},
"sizes": {
"additionalProperties": {
"type": "string"
},
"description": "URLs of the picture for different sizes, if available on a CDN.",
"type": "object"
}
},
"type": "object"
},
"require_password_update": {
"type": "boolean"
},
"state": {
"default": "STATE_REQUESTED",
"description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.",
"enum": [
"STATE_REQUESTED",
"STATE_APPROVED",
"STATE_REJECTED",
"STATE_FLAGGED",
"STATE_SUSPENDED"
],
"type": "string"
},
"state_description": {
"description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.",
"type": "string"
},
"temporary_password": {
"description": "The temporary password can only be used to update a user's password; never returned on API calls.\nIt is not returned on API calls, and can not be updated by updating the User.\nSee the CreateTemporaryPassword method of the UserRegistry service for more information.",
"type": "string"
},
"temporary_password_created_at": {
"format": "date-time",
"type": "string"
},
"temporary_password_expires_at": {
"format": "date-time",
"type": "string"
},
"updated_at": {
"description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
TenantRegistry
Manage tenants as a tenant administrator.
get
/tenants
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
field_mask |
string | ||
order |
string | Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. | |
limit |
integer | Limit the number of results per page. | |
page |
integer | Page number for pagination. 0 is interpreted as 1. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"tenants": {
"items": {
"description": "Tenant is the message that defines a Tenant in the network.",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"billing": {
"properties": {
"aws_saas_marketplace": {
"properties": {
"customer_identifier": {
"type": "string"
},
"product_code": {
"type": "string"
}
},
"type": "object"
},
"counting": {
"properties": {
"end_devices": {
"default": "ALL",
"enum": [
"ALL",
"ONLY_ACTIVATED"
],
"type": "string"
}
},
"type": "object"
},
"stripe": {
"properties": {
"customer_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"subscription_id": {
"type": "string"
},
"subscription_item_id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"billing_identifiers": {
"properties": {
"billing_id": {
"type": "string"
}
},
"type": "object"
},
"capabilities": {
"type": "object"
},
"configuration": {
"properties": {
"clusters": {
"additionalProperties": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Configuration per cluster (by ID).",
"type": "object"
},
"default_cluster": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"pb": {
"properties": {
"listed": {
"description": "Indicates whether the Home Network is publicly listed.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"contact_info": {
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"tenant_id": {
"type": "string"
}
},
"type": "object"
},
"max_applications": {
"description": "If set, restricts the maximum number of applications that can be created.",
"format": "uint64",
"type": "string"
},
"max_clients": {
"description": "If set, restricts the maximum number of clients that can be created.",
"format": "uint64",
"type": "string"
},
"max_end_devices": {
"description": "If set, restricts the maximum number of end_devices that can be created.",
"format": "uint64",
"type": "string"
},
"max_gateways": {
"description": "If set, restricts the maximum number of gateways that can be created.",
"format": "uint64",
"type": "string"
},
"max_organizations": {
"description": "If set, restricts the maximum number of organizations that can be created.",
"format": "uint64",
"type": "string"
},
"max_users": {
"description": "If set, restricts the maximum number of users that can be created.",
"format": "uint64",
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"default": "STATE_REQUESTED",
"description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.",
"enum": [
"STATE_REQUESTED",
"STATE_APPROVED",
"STATE_REJECTED",
"STATE_FLAGGED",
"STATE_SUSPENDED"
],
"type": "string"
},
"state_description": {
"description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/tenants
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"initial_user": {
"description": "User is the message that defines a user on the network.",
"properties": {
"admin": {
"description": "This user is an admin.\nThis information is public and can be seen by any authenticated user in the network.\nThis field can only be modified by other admins.",
"type": "boolean"
},
"application_limit": {
"description": "The maximum number of applications of the user.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Key-value attributes for this users. Typically used for storing integration-specific data.",
"type": "object"
},
"client_limit": {
"description": "The maximum number of clients of the user.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"console_preferences": {
"description": "UserConsolePreferences is the message that defines the user preferences for the Console.",
"properties": {
"console_theme": {
"default": "CONSOLE_THEME_SYSTEM",
"description": "ConsoleTheme is the theme of the Console.\n\n - CONSOLE_THEME_SYSTEM: The user prefers the system mode.\n - CONSOLE_THEME_LIGHT: The user prefers the light mode.\n - CONSOLE_THEME_DARK: The user prefers the dark mode.",
"enum": [
"CONSOLE_THEME_SYSTEM",
"CONSOLE_THEME_LIGHT",
"CONSOLE_THEME_DARK"
],
"type": "string"
},
"dashboard_layouts": {
"properties": {
"api_key": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"application": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"collaborator": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"end_device": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"gateway": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"organization": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"overview": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
},
"user": {
"default": "DASHBOARD_LAYOUT_TABLE",
"description": "DashboardLayout is a set of possible layout values to be used in the Console.",
"enum": [
"DASHBOARD_LAYOUT_TABLE",
"DASHBOARD_LAYOUT_LIST",
"DASHBOARD_LAYOUT_GRID"
],
"type": "string"
}
},
"type": "object"
},
"sort_by": {
"description": "SortBy defines the field to which the Console will sort the display of entities.",
"properties": {
"api_key": {
"type": "string"
},
"application": {
"type": "string"
},
"collaborator": {
"type": "string"
},
"end_device": {
"type": "string"
},
"gateway": {
"type": "string"
},
"organization": {
"type": "string"
},
"user": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"contact_info": {
"description": "Contact information for this user. Typically used to indicate who to contact with security/billing questions about the user.\nThis field is deprecated.",
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"description": "When the user was created. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"deleted_at": {
"description": "When the user was deleted. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"description": {
"description": "A description for the user. This information is public and can be seen by any authenticated user in the network.",
"type": "string"
},
"gateway_limit": {
"description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "The name of the user. This information is public and can be seen by any authenticated user in the network.",
"type": "string"
},
"organization_limit": {
"description": "The maximum number of organizations of the user.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"password": {
"description": "The password field is only considered when creating a user.\nIt is not returned on API calls, and can not be updated by updating the User.\nSee the UpdatePassword method of the UserRegistry service for more information.",
"type": "string"
},
"password_updated_at": {
"format": "date-time",
"type": "string"
},
"primary_email_address": {
"description": "Primary email address that can be used for logging in.\nThis address is not public, use contact_info for that.",
"type": "string"
},
"primary_email_address_validated_at": {
"description": "When the primary email address was validated. Note that email address validation is not required on all networks.",
"format": "date-time",
"type": "string"
},
"profile_picture": {
"properties": {
"embedded": {
"properties": {
"data": {
"description": "Picture data. A data URI can be constructed as follows:\n`data:\u003cmime_type\u003e;base64,\u003cdata\u003e`.",
"format": "byte",
"type": "string"
},
"mime_type": {
"description": "MIME type of the picture.",
"type": "string"
}
},
"type": "object"
},
"sizes": {
"additionalProperties": {
"type": "string"
},
"description": "URLs of the picture for different sizes, if available on a CDN.",
"type": "object"
}
},
"type": "object"
},
"require_password_update": {
"type": "boolean"
},
"state": {
"default": "STATE_REQUESTED",
"description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.",
"enum": [
"STATE_REQUESTED",
"STATE_APPROVED",
"STATE_REJECTED",
"STATE_FLAGGED",
"STATE_SUSPENDED"
],
"type": "string"
},
"state_description": {
"description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.",
"type": "string"
},
"temporary_password": {
"description": "The temporary password can only be used to update a user's password; never returned on API calls.\nIt is not returned on API calls, and can not be updated by updating the User.\nSee the CreateTemporaryPassword method of the UserRegistry service for more information.",
"type": "string"
},
"temporary_password_created_at": {
"format": "date-time",
"type": "string"
},
"temporary_password_expires_at": {
"format": "date-time",
"type": "string"
},
"updated_at": {
"description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"tenant": {
"description": "Tenant is the message that defines a Tenant in the network.",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"billing": {
"properties": {
"aws_saas_marketplace": {
"properties": {
"customer_identifier": {
"type": "string"
},
"product_code": {
"type": "string"
}
},
"type": "object"
},
"counting": {
"properties": {
"end_devices": {
"default": "ALL",
"enum": [
"ALL",
"ONLY_ACTIVATED"
],
"type": "string"
}
},
"type": "object"
},
"stripe": {
"properties": {
"customer_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"subscription_id": {
"type": "string"
},
"subscription_item_id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"billing_identifiers": {
"properties": {
"billing_id": {
"type": "string"
}
},
"type": "object"
},
"capabilities": {
"type": "object"
},
"configuration": {
"properties": {
"clusters": {
"additionalProperties": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Configuration per cluster (by ID).",
"type": "object"
},
"default_cluster": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"pb": {
"properties": {
"listed": {
"description": "Indicates whether the Home Network is publicly listed.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"contact_info": {
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"tenant_id": {
"type": "string"
}
},
"type": "object"
},
"max_applications": {
"description": "If set, restricts the maximum number of applications that can be created.",
"format": "uint64",
"type": "string"
},
"max_clients": {
"description": "If set, restricts the maximum number of clients that can be created.",
"format": "uint64",
"type": "string"
},
"max_end_devices": {
"description": "If set, restricts the maximum number of end_devices that can be created.",
"format": "uint64",
"type": "string"
},
"max_gateways": {
"description": "If set, restricts the maximum number of gateways that can be created.",
"format": "uint64",
"type": "string"
},
"max_organizations": {
"description": "If set, restricts the maximum number of organizations that can be created.",
"format": "uint64",
"type": "string"
},
"max_users": {
"description": "If set, restricts the maximum number of users that can be created.",
"format": "uint64",
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"default": "STATE_REQUESTED",
"description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.",
"enum": [
"STATE_REQUESTED",
"STATE_APPROVED",
"STATE_REJECTED",
"STATE_FLAGGED",
"STATE_SUSPENDED"
],
"type": "string"
},
"state_description": {
"description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"attributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"billing": {
"properties": {
"aws_saas_marketplace": {
"properties": {
"customer_identifier": {
"type": "string"
},
"product_code": {
"type": "string"
}
},
"type": "object"
},
"counting": {
"properties": {
"end_devices": {
"default": "ALL",
"enum": [
"ALL",
"ONLY_ACTIVATED"
],
"type": "string"
}
},
"type": "object"
},
"stripe": {
"properties": {
"customer_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"subscription_id": {
"type": "string"
},
"subscription_item_id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"billing_identifiers": {
"properties": {
"billing_id": {
"type": "string"
}
},
"type": "object"
},
"capabilities": {
"type": "object"
},
"configuration": {
"properties": {
"clusters": {
"additionalProperties": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Configuration per cluster (by ID).",
"type": "object"
},
"default_cluster": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"pb": {
"properties": {
"listed": {
"description": "Indicates whether the Home Network is publicly listed.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"contact_info": {
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"tenant_id": {
"type": "string"
}
},
"type": "object"
},
"max_applications": {
"description": "If set, restricts the maximum number of applications that can be created.",
"format": "uint64",
"type": "string"
},
"max_clients": {
"description": "If set, restricts the maximum number of clients that can be created.",
"format": "uint64",
"type": "string"
},
"max_end_devices": {
"description": "If set, restricts the maximum number of end_devices that can be created.",
"format": "uint64",
"type": "string"
},
"max_gateways": {
"description": "If set, restricts the maximum number of gateways that can be created.",
"format": "uint64",
"type": "string"
},
"max_organizations": {
"description": "If set, restricts the maximum number of organizations that can be created.",
"format": "uint64",
"type": "string"
},
"max_users": {
"description": "If set, restricts the maximum number of users that can be created.",
"format": "uint64",
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"default": "STATE_REQUESTED",
"description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.",
"enum": [
"STATE_REQUESTED",
"STATE_APPROVED",
"STATE_REJECTED",
"STATE_FLAGGED",
"STATE_SUSPENDED"
],
"type": "string"
},
"state_description": {
"description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
post
/tenants/registry-totals
Request Parameters
| Field | Type | Required | Description |
|---|
Request Body
Show JSON Schema
{
"field_mask": {
"type": "string"
},
"tenant_ids": {
"items": {
"properties": {
"tenant_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"totals": {
"items": {
"properties": {
"tenant_ids": {
"properties": {
"tenant_id": {
"type": "string"
}
},
"type": "object"
},
"totals": {
"properties": {
"activated_end_devices": {
"format": "uint64",
"type": "string"
},
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"end_devices": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
},
"users": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
put
/tenants/{tenant.ids.tenant_id}
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
tenant.ids.tenant_id |
string | true |
Request Body
Show JSON Schema
{
"field_mask": {
"type": "string"
},
"tenant": {
"description": "Tenant is the message that defines a Tenant in the network.",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"billing": {
"properties": {
"aws_saas_marketplace": {
"properties": {
"customer_identifier": {
"type": "string"
},
"product_code": {
"type": "string"
}
},
"type": "object"
},
"counting": {
"properties": {
"end_devices": {
"default": "ALL",
"enum": [
"ALL",
"ONLY_ACTIVATED"
],
"type": "string"
}
},
"type": "object"
},
"stripe": {
"properties": {
"customer_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"subscription_id": {
"type": "string"
},
"subscription_item_id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"billing_identifiers": {
"properties": {
"billing_id": {
"type": "string"
}
},
"type": "object"
},
"capabilities": {
"type": "object"
},
"configuration": {
"properties": {
"clusters": {
"additionalProperties": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Configuration per cluster (by ID).",
"type": "object"
},
"default_cluster": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"pb": {
"properties": {
"listed": {
"description": "Indicates whether the Home Network is publicly listed.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"contact_info": {
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"type": "object"
},
"max_applications": {
"description": "If set, restricts the maximum number of applications that can be created.",
"format": "uint64",
"type": "string"
},
"max_clients": {
"description": "If set, restricts the maximum number of clients that can be created.",
"format": "uint64",
"type": "string"
},
"max_end_devices": {
"description": "If set, restricts the maximum number of end_devices that can be created.",
"format": "uint64",
"type": "string"
},
"max_gateways": {
"description": "If set, restricts the maximum number of gateways that can be created.",
"format": "uint64",
"type": "string"
},
"max_organizations": {
"description": "If set, restricts the maximum number of organizations that can be created.",
"format": "uint64",
"type": "string"
},
"max_users": {
"description": "If set, restricts the maximum number of users that can be created.",
"format": "uint64",
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"default": "STATE_REQUESTED",
"description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.",
"enum": [
"STATE_REQUESTED",
"STATE_APPROVED",
"STATE_REJECTED",
"STATE_FLAGGED",
"STATE_SUSPENDED"
],
"type": "string"
},
"state_description": {
"description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"attributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"billing": {
"properties": {
"aws_saas_marketplace": {
"properties": {
"customer_identifier": {
"type": "string"
},
"product_code": {
"type": "string"
}
},
"type": "object"
},
"counting": {
"properties": {
"end_devices": {
"default": "ALL",
"enum": [
"ALL",
"ONLY_ACTIVATED"
],
"type": "string"
}
},
"type": "object"
},
"stripe": {
"properties": {
"customer_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"subscription_id": {
"type": "string"
},
"subscription_item_id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"billing_identifiers": {
"properties": {
"billing_id": {
"type": "string"
}
},
"type": "object"
},
"capabilities": {
"type": "object"
},
"configuration": {
"properties": {
"clusters": {
"additionalProperties": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Configuration per cluster (by ID).",
"type": "object"
},
"default_cluster": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"pb": {
"properties": {
"listed": {
"description": "Indicates whether the Home Network is publicly listed.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"contact_info": {
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"tenant_id": {
"type": "string"
}
},
"type": "object"
},
"max_applications": {
"description": "If set, restricts the maximum number of applications that can be created.",
"format": "uint64",
"type": "string"
},
"max_clients": {
"description": "If set, restricts the maximum number of clients that can be created.",
"format": "uint64",
"type": "string"
},
"max_end_devices": {
"description": "If set, restricts the maximum number of end_devices that can be created.",
"format": "uint64",
"type": "string"
},
"max_gateways": {
"description": "If set, restricts the maximum number of gateways that can be created.",
"format": "uint64",
"type": "string"
},
"max_organizations": {
"description": "If set, restricts the maximum number of organizations that can be created.",
"format": "uint64",
"type": "string"
},
"max_users": {
"description": "If set, restricts the maximum number of users that can be created.",
"format": "uint64",
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"default": "STATE_REQUESTED",
"description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.",
"enum": [
"STATE_REQUESTED",
"STATE_APPROVED",
"STATE_REJECTED",
"STATE_FLAGGED",
"STATE_SUSPENDED"
],
"type": "string"
},
"state_description": {
"description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/tenants/{tenant_ids.tenant_id}
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
tenant_ids.tenant_id |
string | true | |
field_mask |
string |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"attributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"billing": {
"properties": {
"aws_saas_marketplace": {
"properties": {
"customer_identifier": {
"type": "string"
},
"product_code": {
"type": "string"
}
},
"type": "object"
},
"counting": {
"properties": {
"end_devices": {
"default": "ALL",
"enum": [
"ALL",
"ONLY_ACTIVATED"
],
"type": "string"
}
},
"type": "object"
},
"stripe": {
"properties": {
"customer_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"subscription_id": {
"type": "string"
},
"subscription_item_id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"billing_identifiers": {
"properties": {
"billing_id": {
"type": "string"
}
},
"type": "object"
},
"capabilities": {
"type": "object"
},
"configuration": {
"properties": {
"clusters": {
"additionalProperties": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Configuration per cluster (by ID).",
"type": "object"
},
"default_cluster": {
"properties": {
"ars": {
"properties": {
"routing": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"as": {
"properties": {
"webhooks": {
"properties": {
"queue": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"gs": {
"properties": {
"mtls_authentication": {
"properties": {
"client_ca_pool": {
"description": "PEM encoded pool of X.509 root certificates to trust for verifying the presented TLS client certificate.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"is": {
"properties": {
"admin_rights": {
"properties": {
"all": {
"type": "boolean"
}
},
"type": "object"
},
"application_limits": {
"properties": {
"end_devices": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"email": {
"properties": {
"network": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"end_device_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
}
},
"type": "object"
},
"organization_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"profile_picture": {
"properties": {
"disable_upload": {
"type": "boolean"
},
"use_gravatar": {
"type": "boolean"
}
},
"type": "object"
},
"user_limits": {
"properties": {
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"user_login": {
"properties": {
"disable_credentials_login": {
"type": "boolean"
}
},
"type": "object"
},
"user_registration": {
"properties": {
"admin_approval": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"contact_info_validation": {
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"invitation": {
"properties": {
"required": {
"type": "boolean"
},
"token_ttl": {
"type": "string"
}
},
"type": "object"
},
"password_requirements": {
"properties": {
"max_length": {
"format": "int64",
"type": "integer"
},
"min_digits": {
"format": "int64",
"type": "integer"
},
"min_length": {
"format": "int64",
"type": "integer"
},
"min_special": {
"format": "int64",
"type": "integer"
},
"min_uppercase": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"user_rights": {
"properties": {
"create_applications": {
"type": "boolean"
},
"create_clients": {
"type": "boolean"
},
"create_gateways": {
"type": "boolean"
},
"create_organizations": {
"type": "boolean"
},
"update_name": {
"type": "boolean"
},
"update_primary_email_address": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"js": {
"properties": {
"join_eui_prefixes": {
"example": [
"70B3D57ED0000000/56"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"noc": {
"properties": {
"access": {
"properties": {
"extended": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ns": {
"properties": {
"cooldown_window": {
"type": "string"
},
"deduplication_window": {
"type": "string"
},
"dev_addr_prefixes": {
"example": [
"2600AB00/24"
],
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"net_id": {
"example": "000013",
"format": "string",
"type": "string"
},
"ns_id": {
"example": "70B3D57ED000ABCD",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"ui": {
"properties": {
"branding_base_url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"pb": {
"properties": {
"listed": {
"description": "Indicates whether the Home Network is publicly listed.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"contact_info": {
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"ids": {
"properties": {
"tenant_id": {
"type": "string"
}
},
"type": "object"
},
"max_applications": {
"description": "If set, restricts the maximum number of applications that can be created.",
"format": "uint64",
"type": "string"
},
"max_clients": {
"description": "If set, restricts the maximum number of clients that can be created.",
"format": "uint64",
"type": "string"
},
"max_end_devices": {
"description": "If set, restricts the maximum number of end_devices that can be created.",
"format": "uint64",
"type": "string"
},
"max_gateways": {
"description": "If set, restricts the maximum number of gateways that can be created.",
"format": "uint64",
"type": "string"
},
"max_organizations": {
"description": "If set, restricts the maximum number of organizations that can be created.",
"format": "uint64",
"type": "string"
},
"max_users": {
"description": "If set, restricts the maximum number of users that can be created.",
"format": "uint64",
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"default": "STATE_REQUESTED",
"description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.",
"enum": [
"STATE_REQUESTED",
"STATE_APPROVED",
"STATE_REJECTED",
"STATE_FLAGGED",
"STATE_SUSPENDED"
],
"type": "string"
},
"state_description": {
"description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/tenants/{tenant_ids.tenant_id}/registry-totals
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
tenant_ids.tenant_id |
string | true | |
field_mask |
string |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"activated_end_devices": {
"format": "uint64",
"type": "string"
},
"applications": {
"format": "uint64",
"type": "string"
},
"clients": {
"format": "uint64",
"type": "string"
},
"end_devices": {
"format": "uint64",
"type": "string"
},
"gateways": {
"format": "uint64",
"type": "string"
},
"organizations": {
"format": "uint64",
"type": "string"
},
"users": {
"format": "uint64",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
delete
/tenants/{tenant_id}
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
tenant_id |
string | true |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. | None |
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
TenantAccess
Manage access to tenants.
post
/tenants/{tenant_ids.tenant_id}/resend-admin-validation
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
tenant_ids.tenant_id |
string | true |
Request Body
Show JSON Schema
{
"tenant_ids": {
"type": "object"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. | None |
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
Tbs
Report metering data to external billing services.
post
/tbs/report
Request Parameters
| Field | Type | Required | Description |
|---|
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. | None |
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
ApplicationRegistry
Manage applications.
get
/applications
List applications where the given user or organization is a direct collaborator.
If no user or organization is given, this returns the applications the caller has access to. Similar to Get, this selects the fields given by the field mask. More or less fields may be returned, depending on the rights of the caller.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
collaborator.organization_ids.organization_id |
string | This ID shares namespace with user IDs. | |
collaborator.user_ids.user_id |
string | This ID shares namespace with organization IDs. | |
collaborator.user_ids.email |
string | Secondary identifier, which can only be used in specific requests. | |
field_mask |
string | The names of the application fields that should be returned. | |
order |
string | Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. | |
limit |
integer | Limit the number of results per page. | |
page |
integer | Page number for pagination. 0 is interpreted as 1. | |
deleted |
boolean | Only return recently deleted applications. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"applications": {
"items": {
"description": "Application is the message that defines an Application in the network.",
"properties": {
"administrative_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"application_server_address": {
"description": "The address of the Application Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Key-value attributes for this application. Typically used for organizing applications or for storing integration-specific data.",
"type": "object"
},
"contact_info": {
"description": "Contact information for this application. Typically used to indicate who to contact with technical/security questions about the application.\nThis field is deprecated. Use administrative_contact and technical_contact instead.",
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"description": "When the application was created. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"deleted_at": {
"description": "When the application was deleted. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"description": {
"description": "A description for the application.",
"type": "string"
},
"dev_eui_counter": {
"format": "int64",
"type": "integer"
},
"end_device_limit": {
"description": "The limit of the number of end devices that can be registered for this application.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"ids": {
"properties": {
"application_id": {
"type": "string"
}
},
"type": "object"
},
"join_server_address": {
"description": "The address of the Join Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"network_server_address": {
"description": "The address of the Network Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"technical_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"updated_at": {
"description": "When the application was last updated. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
put
/applications/{application.ids.application_id}
Update the application, changing the fields specified by the field mask to the provided values.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application.ids.application_id |
string | true |
Request Body
Show JSON Schema
{
"application": {
"description": "Application is the message that defines an Application in the network.",
"properties": {
"administrative_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"application_server_address": {
"description": "The address of the Application Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Key-value attributes for this application. Typically used for organizing applications or for storing integration-specific data.",
"type": "object"
},
"contact_info": {
"description": "Contact information for this application. Typically used to indicate who to contact with technical/security questions about the application.\nThis field is deprecated. Use administrative_contact and technical_contact instead.",
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"description": "When the application was created. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"deleted_at": {
"description": "When the application was deleted. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"description": {
"description": "A description for the application.",
"type": "string"
},
"dev_eui_counter": {
"format": "int64",
"type": "integer"
},
"end_device_limit": {
"description": "The limit of the number of end devices that can be registered for this application.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"ids": {
"description": "The identifiers of the application. These are public and can be seen by any authenticated user in the network.",
"title": "The identifiers of the application. These are public and can be seen by any authenticated user in the network.",
"type": "object"
},
"join_server_address": {
"description": "The address of the Join Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"network_server_address": {
"description": "The address of the Network Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"technical_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"updated_at": {
"description": "When the application was last updated. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"field_mask": {
"description": "The names of the application fields that should be updated.",
"type": "string"
}
}
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"administrative_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"application_server_address": {
"description": "The address of the Application Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Key-value attributes for this application. Typically used for organizing applications or for storing integration-specific data.",
"type": "object"
},
"contact_info": {
"description": "Contact information for this application. Typically used to indicate who to contact with technical/security questions about the application.\nThis field is deprecated. Use administrative_contact and technical_contact instead.",
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"description": "When the application was created. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"deleted_at": {
"description": "When the application was deleted. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"description": {
"description": "A description for the application.",
"type": "string"
},
"dev_eui_counter": {
"format": "int64",
"type": "integer"
},
"end_device_limit": {
"description": "The limit of the number of end devices that can be registered for this application.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"ids": {
"properties": {
"application_id": {
"type": "string"
}
},
"type": "object"
},
"join_server_address": {
"description": "The address of the Join Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"network_server_address": {
"description": "The address of the Network Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"technical_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"updated_at": {
"description": "When the application was last updated. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
}
|
get
/applications/{application_ids.application_id}
Get the application with the given identifiers, selecting the fields specified in the field mask.
More or less fields may be returned, depending on the rights of the caller.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
application_ids.application_id |
string | true | |
field_mask |
string | The names of the application fields that should be returned. |
Responses
| Code | Description | Return Value |
|---|---|---|
| 200 | A successful response. |
Show JSON Schema
{
"administrative_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"application_server_address": {
"description": "The address of the Application Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Key-value attributes for this application. Typically used for organizing applications or for storing integration-specific data.",
"type": "object"
},
"contact_info": {
"description": "Contact information for this application. Typically used to indicate who to contact with technical/security questions about the application.\nThis field is deprecated. Use administrative_contact and technical_contact instead.",
"items": {
"properties": {
"contact_method": {
"default": "CONTACT_METHOD_OTHER",
"enum": [
"CONTACT_METHOD_OTHER",
"CONTACT_METHOD_EMAIL",
"CONTACT_METHOD_PHONE"
],
"type": "string"
},
"contact_type": {
"default": "CONTACT_TYPE_OTHER",
"enum": [
"CONTACT_TYPE_OTHER",
"CONTACT_TYPE_ABUSE",
"CONTACT_TYPE_BILLING",
"CONTACT_TYPE_TECHNICAL"
],
"type": "string"
},
"public": {
"type": "boolean"
},
"validated_at": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_at": {
"description": "When the application was created. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"deleted_at": {
"description": "When the application was deleted. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
},
"description": {
"description": "A description for the application.",
"type": "string"
},
"dev_eui_counter": {
"format": "int64",
"type": "integer"
},
"end_device_limit": {
"description": "The limit of the number of end devices that can be registered for this application.\nThis field can only be modified by admins.",
"format": "uint64",
"type": "string"
},
"ids": {
"properties": {
"application_id": {
"type": "string"
}
},
"type": "object"
},
"join_server_address": {
"description": "The address of the Join Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"network_server_address": {
"description": "The address of the Network Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.",
"type": "string"
},
"technical_contact": {
"description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.",
"properties": {
"organization_ids": {
"properties": {
"organization_id": {
"description": "This ID shares namespace with user IDs.",
"type": "string"
}
},
"type": "object"
},
"user_ids": {
"properties": {
"email": {
"description": "Secondary identifier, which can only be used in specific requests.",
"type": "string"
},
"user_id": {
"description": "This ID shares namespace with organization IDs.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"updated_at": {
"description": "When the application was last updated. This information is public and can be seen by any authenticated user in the network.",
"format": "date-time",
"type": "string"
}
}
|
| default | An unexpected error response. |
Show JSON Schema
{
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"additionalProperties": {},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"properties": {
"@type": {
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other th |