OMF Connections
- Last UpdatedSep 08, 2023
- 4 minute read
APIs for managing OmfConnections.
Get OMF Connections
Gets a list of all OmfConnection objects in the given namespace.
Request
GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/omfConnections
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | OmfConnections | OmfConnections object that contains a list of OmfConnection objects |
| 401 | ErrorResponseBody | Unauthorized |
| 403 | ErrorResponseBody | Forbidden |
| 404 | ErrorResponseBody | Resource not found |
| 408 | ErrorResponseBody | Request timeout |
| 500 | ErrorResponseBody | Internal server error |
| 503 | ErrorResponseBody | Service unavailable |
| 504 | ErrorResponseBody | Gateway timeout |
Example response body
200 Response
{
"Results": [
{
"Id": "009d8600-fb20-4a6a-8368-e74863a83c4c",
"Name": "OmfConnection1 name",
"State": "Active",
"Description": "OmfConnection1 description",
"CreatedDate": "2021-03-18T23:57:44.6109361Z",
"ClientIds": [
"d6b178a4-0de5-4c30-8ba7-0a84751be854"
]
},
{
"Id": "b7e1393c-ebd1-41e0-97ef-362bead4508d",
"Name": "OmfConnection2 name",
"State": "Creating",
"Description": "OmfConnection2 description",
"CreatedDate": "2022-01-05T03:35:24.6309361Z",
"ClientIds": [
"feecf1d0-b366-4a8b-91d2-92bee976686e"
]
}
]
}
401 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Create OMF Connection
Creates a new OmfConnection mapped to the specified ClientIds. A given ClientId may only be mapped to one OmfConnection per namespace.
Request
POST /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/omfConnections
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.
Request Body
The omfConnectionCreate object to create
{
"Name": "OmfConnection name",
"Description": "OmfConnection description",
"ClientIds": [
"d6b178a4-0de5-4c30-8ba7-0a84751be854"
]
}
Response
| Status Code | Body Type | Description |
|---|---|---|
| 202 | OmfConnection | The created OmfConnection |
| 400 | ErrorResponseBody | Bad request |
| 401 | ErrorResponseBody | Unauthorized |
| 403 | ErrorResponseBody | Forbidden |
| 404 | ErrorResponseBody | Resource not found |
| 408 | ErrorResponseBody | Request timeout |
| 415 | ErrorResponseBody | Unsupported media type |
| 500 | ErrorResponseBody | Internal server error |
| 503 | ErrorResponseBody | Service unavailable |
| 504 | ErrorResponseBody | Gateway timeout |
Example response body
202 Response
{
"Id": "009d8600-fb20-4a6a-8368-e74863a83c4c",
"Name": "OmfConnection name",
"State": "Active",
"Description": "OmfConnection description",
"CreatedDate": "2021-03-18T23:57:44.6109361Z",
"ClientIds": [
"d6b178a4-0de5-4c30-8ba7-0a84751be854"
]
}
400 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Get OMF Connection
Gets the specified OmfConnection.
Request
GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/omfConnections/{omfConnectionId}
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string omfConnectionId
OMF connection identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | OmfConnection | The specified OmfConnection |
| 401 | ErrorResponseBody | Unauthorized |
| 403 | ErrorResponseBody | Forbidden |
| 404 | ErrorResponseBody | Resource not found |
| 408 | ErrorResponseBody | Request timeout |
| 500 | ErrorResponseBody | Internal server error |
| 503 | ErrorResponseBody | Service unavailable |
| 504 | ErrorResponseBody | Gateway timeout |
Example response body
200 Response
{
"Id": "009d8600-fb20-4a6a-8368-e74863a83c4c",
"Name": "OmfConnection name",
"State": "Active",
"Description": "OmfConnection description",
"CreatedDate": "2021-03-18T23:57:44.6109361Z",
"ClientIds": [
"d6b178a4-0de5-4c30-8ba7-0a84751be854"
]
}
401 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Update OMF Connection
Updates the Name, Description, and/or ClientIds for the specified OmfConnection.
Request
PUT /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/omfConnections/{omfConnectionId}
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string omfConnectionId
OMF connection identifier.
Request Body
The OmfConnectionUpdate with the fields to update
{
"Name": "OmfConnection name",
"Description": "OmfConnection description",
"ClientIds": [
"7f17ba9e-51cc-47c4-8df4-22e5e641e9a4"
]
}
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | OmfConnection | The updated OmfConnection |
| 400 | ErrorResponseBody | Bad request |
| 401 | ErrorResponseBody | Unauthorized |
| 403 | ErrorResponseBody | Forbidden |
| 404 | ErrorResponseBody | Resource not found |
| 408 | ErrorResponseBody | Request timeout |
| 415 | ErrorResponseBody | Unsupported media type |
| 500 | ErrorResponseBody | Internal server error |
| 503 | ErrorResponseBody | Service unavailable |
| 504 | ErrorResponseBody | Gateway timeout |
Example response body
200 Response
{
"Id": "009d8600-fb20-4a6a-8368-e74863a83c4c",
"Name": "OmfConnection name",
"State": "Active",
"Description": "OmfConnection description",
"CreatedDate": "2021-03-18T23:57:44.6109361Z",
"ClientIds": [
"d6b178a4-0de5-4c30-8ba7-0a84751be854"
]
}
400 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Delete OMF Connection
Deletes the specified OmfConnection.
Request
DELETE /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/omfConnections/{omfConnectionId}
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string omfConnectionId
OMF connection identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 202 | OmfConnection | No content |
| 401 | ErrorResponseBody | Unauthorized |
| 403 | ErrorResponseBody | Forbidden |
| 404 | ErrorResponseBody | Resource not found |
| 408 | ErrorResponseBody | Request timeout |
| 500 | ErrorResponseBody | Internal server error |
| 503 | ErrorResponseBody | Service unavailable |
| 504 | ErrorResponseBody | Gateway timeout |
Example response body
202 Response
{
"Id": "009d8600-fb20-4a6a-8368-e74863a83c4c",
"Name": "OmfConnection name",
"State": "Active",
"Description": "OmfConnection description",
"CreatedDate": "2021-03-18T23:57:44.6109361Z",
"ClientIds": [
"d6b178a4-0de5-4c30-8ba7-0a84751be854"
]
}
401 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Definitions
OmfConnections
Object returned when fetching all OmfConnection objects in the given namespace.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Results | [OmfConnection] | false | true | List of OmfConnection objects. |
{
"Results": [
{
"Id": "009d8600-fb20-4a6a-8368-e74863a83c4c",
"Name": "OmfConnection1 name",
"State": "Active",
"Description": "OmfConnection1 description",
"CreatedDate": "2021-03-18T23:57:44.6109361Z",
"ClientIds": [
"d6b178a4-0de5-4c30-8ba7-0a84751be854"
]
},
{
"Id": "b7e1393c-ebd1-41e0-97ef-362bead4508d",
"Name": "OmfConnection2 name",
"State": "Creating",
"Description": "OmfConnection2 description",
"CreatedDate": "2022-01-05T03:35:24.6309361Z",
"ClientIds": [
"feecf1d0-b366-4a8b-91d2-92bee976686e"
]
}
]
}
OmfConnection
Object returned from OmfConnection routes.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Id | string | false | true | Server-generated unique identifier. |
| Name | string | false | true | User-specified name. Limit 200 characters. |
| State | string | false | true | Current OmfConnection state. Possible values are Creating, Active, Deleting and Deleted. Set by the server. |
| Description | string | false | true | A description. Limit 1000 characters. |
| CreatedDate | date-time | false | false | Server-generated creation timestamp (UTC). |
| ClientIds | string[] | false | true | List of Client identifiers. Data sent by these clients will be sent to this OmfConnection. Limit 10000 Client identifiers. |
{
"Id": "009d8600-fb20-4a6a-8368-e74863a83c4c",
"Name": "OmfConnection name",
"State": "Active",
"Description": "OmfConnection description",
"CreatedDate": "2021-03-18T23:57:44.6109361Z",
"ClientIds": [
"d6b178a4-0de5-4c30-8ba7-0a84751be854"
]
}
ErrorResponseBody
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | false | true | None |
| Error | string | false | true | None |
| Reason | string | false | true | None |
| Resolution | string | false | true | None |
| Parameters | object | false | true | None |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
OmfConnectionCreate
Object used to create an OmfConnection.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Name | string | false | true | User-specified name. Limit 200 characters. |
| Description | string | false | true | A description. Limit 1000 characters. |
| ClientIds | string[] | true | false | List of Client identifiers. Data sent by these clients will be sent to this OmfConnection. Limit 10000 Client identifiers. |
{
"Name": "OmfConnection name",
"Description": "OmfConnection description",
"ClientIds": [
"d6b178a4-0de5-4c30-8ba7-0a84751be854"
]
}
OmfConnectionUpdate
Object used to update an OmfConnection.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Name | string | true | false | User-specified name. Limit 200 characters. |
| Description | string | false | true | A description. Limit 1000 characters. |
| ClientIds | string[] | true | false | List of Client identifiers. Data sent by these clients will be sent to this OmfConnection. Limit 10000 Client identifiers. |
{
"Name": "OmfConnection name",
"Description": "OmfConnection description",
"ClientIds": [
"7f17ba9e-51cc-47c4-8df4-22e5e641e9a4"
]
}