API docs by Redocly

Konnect Service Hub (2.1.0)

Download OpenAPI specification:Download

URL: https://konghq.com

The platform API for Kong Konnect Service Hub core.

Add-ons

List Add-ons

Returns a paginated collection of add-ons.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (AddonFilterParameters)

Filters a collection of add-ons.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of add-ons. Supported sort attributes are:

  • name
  • display_name

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Installed Add-ons

List Installed Add-ons

Returns a paginated collection of installed add-ons.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (InstalledAddonFilterParameters)

Filters a collection of installed add-ons.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of installed add-ons. Supported sort attributes are:

  • name
  • enabled

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Fetch Installed Add-on

Returns information about a specific installed add-on.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
addon
required
string
Example: gateway-manager

Machine name of the add-on.

Responses

Response samples

Content type
application/json
{
  • "id": "747368bc-d836-45e6-b855-ab9a3defb3c1",
  • "name": "gateway-manager",
  • "enabled": true,
  • "config": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Install Add-on

Installs the given add-on.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
addon
required
string
Example: gateway-manager

Machine name of the add-on.

Request Body schema: application/json

Request body schema for installing an add-on.

enabled
required
boolean

Whether the add-on is enabled

object (InstalledAddonConfig)
Default: {}

JSON object containing the configuration values for the add-on.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "747368bc-d836-45e6-b855-ab9a3defb3c1",
  • "name": "gateway-manager",
  • "enabled": true,
  • "config": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Update Installed Add-on

Updates the given installed add-on.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
addon
required
string
Example: gateway-manager

Machine name of the add-on.

Request Body schema: application/json

Request body schema for updating an installed add-on.

enabled
boolean

Whether the add-on is enabled

object (InstalledAddonConfig)
Default: {}

JSON object containing the configuration values for the add-on.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "747368bc-d836-45e6-b855-ab9a3defb3c1",
  • "name": "gateway-manager",
  • "enabled": true,
  • "config": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Delete Installed Add-on

Deletes an installed add-on. Returns 404 if the add-on is not installed or not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
addon
required
string
Example: gateway-manager

Machine name of the add-on.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Service Hub Services

List Services

Returns a paginated collection of services.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (ServiceFilterParameters)

Filters a collection of services.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of services. Supported sort attributes are:

  • name
  • created_at
  • updated_at

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create Service

Creates a service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
Request Body schema: application/json

Request body schema for creating a service.

name
required
string [ 1 .. 120 ] characters ^[0-9a-z.-]+$

The name of the Service.

description
string or null <= 2048 characters

The description of the Service.

display_name
required
string [ 1 .. 120 ] characters

The display name of the Service.

object (Labels) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

object (Metadata)

Contains key value pairs information about entity's metadata.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "user-svc",
  • "description": "string",
  • "display_name": "User Service",
  • "labels": {
    },
  • "integrations": [
    ],
  • "metadata": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Fetch Service

Returns information about a service from a given service ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

Responses

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "user-svc",
  • "description": "string",
  • "display_name": "User Service",
  • "labels": {
    },
  • "integrations": [
    ],
  • "metadata": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Update Service

Updates an individual service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

Request Body schema: application/json

Request body schema for updating a service.

name
string [ 1 .. 120 ] characters ^[0-9a-z.-]+$

The name of the Service.

description
string or null <= 2048 characters

The description of the Service.

display_name
string [ 1 .. 120 ] characters

The display name of the Service.

object (LabelsPatch)

JSON Merge Patch object for updating labels fields. To delete an existing label, provide the label key with a null value.

object (Metadata)

Contains key value pairs information about entity's metadata.

Responses

Request samples

Content type
application/json
{
  • "name": "user-svc",
  • "description": "string",
  • "display_name": "User Service",
  • "labels": {
    },
  • "metadata": {}
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "user-svc",
  • "description": "string",
  • "display_name": "User Service",
  • "labels": {
    },
  • "integrations": [
    ],
  • "metadata": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Delete Service

Deletes an individual service. Returns 404 if the service is not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Integrations

List Integrations for Service

Returns a paginated collection of Service Hub integrations associated to the given service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the service.

query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (ServiceIntegrationFilterParameters)

Filters a collection of Service Hub integrations associated to a service.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of Service Hub integrations associated to a service. Supported sort attributes are:

  • name

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create Service Integration

Creates an association between the given integration and service using the data binding provided in the request.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the service.

integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for creating a service integration.

binding
required
string

The integration binding object name.

required
object

JSON object containing the data which binds the integration to the service.

required
object (Labels) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "binding": "pagerduty_service",
  • "data": {
    },
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "id": "6c1118d3-0fe3-4695-ae55-84d6ea020916",
  • "name": "pagerduty",
  • "service_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "binding": "pagerduty_service",
  • "data": {
    },
  • "labels": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Update Service Integration

Updates the association between the given integration and service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the service.

integration
required
string
Example: gateway-manager

Machine name of the integration.

serviceIntegrationId
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

ID of the service integration.

Request Body schema: application/json

Request body schema for updating a service integration.

binding
required
string

The integration binding object name.

required
object

JSON object containing the data which binds the integration to the service.

required
object (Labels) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "binding": "pagerduty_service",
  • "data": {
    },
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "id": "6c1118d3-0fe3-4695-ae55-84d6ea020916",
  • "name": "pagerduty",
  • "service_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "binding": "pagerduty_service",
  • "data": {
    },
  • "labels": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Delete Service Integration

Deletes a Service integration. Returns 404 if the given service or integration is not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the service.

integration
required
string
Example: gateway-manager

Machine name of the integration.

serviceIntegrationId
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

ID of the service integration.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Integration Proxy Request

Proxies a request to an external API made by a Service Hub integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: pagerduty

Machine name of the integration.

Request Body schema: application/json

Request body schema for an integration proxy request.

method
required
string
Enum: "DELETE" "GET" "PATCH" "POST" "PUT"

The HTTP request method.

base_url
required
string <uri>

The base URL of the proxied API as defined in the integration manifest.

path
required
string

The URL path of the proxied API request as defined in the integration manifest.

object

JSON object representing the request body that will be sent to the proxied API.

object

JSON object representing the query parameters that will be sent to the proxied API.

object

JSON object representing the request headers that will be sent to the proxied API.

Responses

Request samples

Content type
application/json
{
  • "method": "GET",
  • "base_url": "https://api.pagerduty.com",
  • "path": "/incidents",
  • "body": {
    },
  • "query": {
    },
  • "headers": {
    }
}

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Integration Auth Credentials

List Installed Integration Auth Credentials

Returns a paginated collection of installed integration auth credentials.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: pagerduty

Machine name of the integration.

query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create Installed Integration Auth Credential

Creates an auth credential for the integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: pagerduty

Machine name of the integration.

Request Body schema: application/json

Request body schema for creating an auth credential for an installed integration.

One of
type
required
string
Value: "oauth"

The authorization type corresponding to the credential

required
object

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
{
  • "id": "95e4f10a-bf10-4724-9378-c3591ad8c6ed",
  • "type": "oauth",
  • "expires_at": "2024-03-30T07:20:50Z",
  • "created_at": "2022-03-30T07:20:50Z"
}

Fetch Installed Integration Auth Credential

Returns context associated to an auth credential for the given installed integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: pagerduty

Machine name of the integration.

authCredentialId
required
string <uuid>
Example: 95e4f10a-bf10-4724-9378-c3591ad8c6ed

ID of the auth credential.

Responses

Response samples

Content type
application/json
{
  • "id": "95e4f10a-bf10-4724-9378-c3591ad8c6ed",
  • "type": "oauth",
  • "expires_at": "2024-03-30T07:20:50Z",
  • "created_at": "2022-03-30T07:20:50Z"
}

Delete Installed Integration Auth Credential

Deletes an auth credential for an integration. Returns 404 if the given credential is not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: pagerduty

Machine name of the integration.

authCredentialId
required
string <uuid>
Example: 95e4f10a-bf10-4724-9378-c3591ad8c6ed

ID of the auth credential.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Discovery Settings

Fetch Service Discovery Settings for Integration

Returns information about the service discovery settings for the given integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Responses

Response samples

Content type
application/json
{
  • "integration": "pagerduty",
  • "enabled": true,
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Upsert Service Discovery Settings for Integration

Updates service discovery settings for the given integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for updating service discovery settings for an integration.

enabled
required
boolean

Whether discovery is enabled for the integration.

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "integration": "pagerduty",
  • "enabled": true,
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Service Documents

List Service Documents

Returns a paginated collection of documents belonging to the given service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

header Parameters
Accept
string (DocumentContentTypeEnum)
Default: application/json
Enum: "application/json" "application/vnd.konnect.document-tree+json"

Responses

Response samples

Content type
{
  • "meta": {
    },
  • "data": [
    ]
}

Create Service Document

Creates a document associated to the given service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

Request Body schema: application/json

Request body schema for creating a document.

title
required
string

document title

parent_document_id
string <uuid>

parent document id

slug
required
string (Slug) <= 80 characters ^[\w-]+$

document slug

status
string (PublishStatus)
Enum: "published" "unpublished"

document publish status

raw_content
required
string <byte>

base64 encoded string of the document content

metadata
object or null

metadata of the document

filename
required
string

name of the uploaded file

Responses

Request samples

Content type
application/json
{
  • "title": "How to create a document in Service Hub.",
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "string",
  • "status": "published",
  • "raw_content": "YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=",
  • "metadata": {
    },
  • "filename": "my_doc.md"
}

Response samples

Content type
application/json
{
  • "document_id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
  • "revision_id": "ecfb698d-77a8-4ab5-91fa-45ee383b48ba"
}

Fetch Service Document

Returns information about a document belonging to a given service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

documentId
required
string <uuid>
Example: 6c1118d3-0fe3-4695-ae55-84d6ea020916

ID of the document belonging to the given service.

header Parameters
Accept
string (DocumentFormatContentTypeEnum)
Default: application/json
Enum: "application/json" "application/vnd.konnect.document-nodes+json"

Responses

Response samples

Content type
{
  • "id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "getting-started",
  • "revision": {
    }
}

Update Service Document

Updates a document belonging to a given service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

documentId
required
string <uuid>
Example: 6c1118d3-0fe3-4695-ae55-84d6ea020916

ID of the document belonging to the given service.

Request Body schema: application/json

Request body schema for updating a document.

parent_document_id
string or null <uuid>

Parent document Id. If this value is explicitly set to null, the document will be put as a top level document at the bottom of the tree.

slug
string (Slug) <= 80 characters ^[\w-]+$

document slug

status
string (PublishStatus)
Enum: "published" "unpublished"

document publish status

title
string

document title

raw_content
string <byte>

base64 encoded string of the document content

filename
string

name of the uploaded file

metadata
object or null

metadata of the document

Responses

Request samples

Content type
application/json
{
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "string",
  • "status": "published",
  • "title": "How to update a document in Konnect DocumentHub",
  • "raw_content": "YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=",
  • "filename": "my_doc.md",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "6c1118d3-0fe3-4695-ae55-84d6ea020916",
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "string",
  • "status": "published",
  • "revision": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Delete Service Document

Deletes an individual document belonging to the given service. Returns 404 if either the service or document is not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

documentId
required
string <uuid>
Example: 6c1118d3-0fe3-4695-ae55-84d6ea020916

ID of the document belonging to the given service.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Move Service Document

Moves a document within the document tree under the given service, using parameters parent_document_id and index.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

documentId
required
string <uuid>
Example: 6c1118d3-0fe3-4695-ae55-84d6ea020916

ID of the document belonging to the given service.

Request Body schema: application/json

Request body schema for moving a document.

parent_document_id
string <uuid>

Represents the document's parent document Id. If this field is not provided, the document will be placed at the top level of the document tree.

index
integer

Represents a zero-indexed document order relative to its siblings under the same parent. For example, if we want to put the document at top level in first position we would send empty parent_document_id and index: 0. This api also supports using a negative index to count backwards from the end of the document list, which means you can put the document in last position by using index: -1.

Responses

Request samples

Content type
application/json
{
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "index": 1
}

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Discovered Entities

List Discovered Entities

Returns a paginated collection of discovered entities.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[before]
string
Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item before this parameter.

page[after]
string
Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item after this parameter.

page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

object (DiscoveredEntityFilterParameters)

Filters a collection of discovered entities.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of discovered entities. Supported sort attributes are:

  • integration
  • created_at
  • updated_at

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Upsert Discovered Entities

Upserts Discovered Entities. The request is transactional, that is, a single failed operation will result in a failed state for all operations.

The maximum amount of entities that can be ingested in a single request is 100.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for upserting discovered entities for an integration.

required
Array of objects (UpsertDiscoveredEntity)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Fetch Discovered Entity

Returns information about a discovered entity.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
discoveredEntityId
required
string <uuid>
Example: cbf06770-fa76-4e94-9226-ec9086938e62

ID of the discovered entity.

Responses

Response samples

Content type
application/json
{
  • "id": "fa3db80f-b661-434e-bd7a-e6c561c3a15c",
  • "integration": "gateway-manager",
  • "deduplication_id": "2f3adee0-3740-4962-a26b-2a75e550535c",
  • "entity_name": "My Service",
  • "scope": "service",
  • "binding": "pagerduty_service",
  • "integration_record": {
    },
  • "data": {
    },
  • "suggestion_rule_evaluation_error": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Suggestion Rules

List System Suggestion Rules

Returns a paginated collection of a system defined suggestion rules.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create Suggestion Rule for Integration

Creates a suggestion rule for the given integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for creating a suggestion rule for an integration.

name
required
string [ 1 .. 120 ] characters

The display name of the suggestion rule

description
string or null [ 1 .. 2048 ] characters
Default: null

The description of the suggestion rule

binding
required
string

The integration binding object name

active
required
boolean

Determines if this suggestion rule should be evaluated when generating suggested actions.

auto_accept
required
boolean

Determines if the suggested action should be applied automatically.

  • true: Suggested action will be applied automatically
  • false: Suggested action will not be automatically applied, user input required
discovery_selector
required
string <= 2048 characters

A boolean string or JQ expression that must evaluate to a boolean value. Supports JQ expressions syntax on discovered entity's integration_record property.

required
IgnoreAction (object) or MapAction (object) (SuggestedRuleAction)
RankAfterPayload (object) or RankBeforePayload (object)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "Suggestion rule description",
  • "binding": "pagerduty_service",
  • "active": true,
  • "auto_accept": true,
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "rank": {
    }
}

Response samples

Content type
application/json
{
  • "id": "22f72bd1-2897-473e-9471-302de3ccf38b",
  • "name": "string",
  • "description": "Suggestion rule description",
  • "binding": "pagerduty_service",
  • "active": true,
  • "auto_accept": true,
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

List Suggestion Rules

Returns a paginated collection of a suggestion rules.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (DiscoverySuggestionRuleFilterParameters)

Filters a collection of discovery suggestion rules.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Fetch Suggestion Rule

Returns information about a suggestion rule from a given suggestion rule ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

suggestionRuleId
required
string <uuid>
Example: 22f72bd1-2897-473e-9471-302de3ccf38b

ID of the suggestion rule.

Responses

Response samples

Content type
application/json
{
  • "id": "22f72bd1-2897-473e-9471-302de3ccf38b",
  • "name": "string",
  • "description": "Suggestion rule description",
  • "binding": "pagerduty_service",
  • "active": true,
  • "auto_accept": true,
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Update Suggestion Rule

Updates the given suggestion rule.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

suggestionRuleId
required
string <uuid>
Example: 22f72bd1-2897-473e-9471-302de3ccf38b

ID of the suggestion rule.

Request Body schema: application/json

Request body schema for creating a suggestion rule for an integration.

name
required
string [ 1 .. 120 ] characters

The display name of the suggestion rule

description
string or null [ 1 .. 2048 ] characters
Default: null

The description of the suggestion rule

binding
required
string

The integration binding object name

active
required
boolean

Determines if this suggestion rule should be evaluated when generating suggested actions.

auto_accept
required
boolean

Determines if the suggested action should be applied automatically.

  • true: Suggested action will be applied automatically
  • false: Suggested action will not be automatically applied, user input required
discovery_selector
required
string <= 2048 characters

A boolean string or JQ expression that must evaluate to a boolean value. Supports JQ expressions syntax on discovered entity's integration_record property.

required
IgnoreAction (object) or MapAction (object) (SuggestedRuleAction)
RankAfterPayload (object) or RankBeforePayload (object)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "Suggestion rule description",
  • "binding": "pagerduty_service",
  • "active": true,
  • "auto_accept": true,
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "rank": {
    }
}

Response samples

Content type
application/json
{
  • "id": "22f72bd1-2897-473e-9471-302de3ccf38b",
  • "name": "string",
  • "description": "Suggestion rule description",
  • "binding": "pagerduty_service",
  • "active": true,
  • "auto_accept": true,
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Delete Suggestion Rule

Deletes the given suggestion rule.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

suggestionRuleId
required
string <uuid>
Example: 22f72bd1-2897-473e-9471-302de3ccf38b

ID of the suggestion rule.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Test a Suggestion Rule Configuration

Test suggestion rule configuration against an integration record.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for testing a suggestion rule configuration against an integration record.

binding
required
string

The integration binding object name

discovery_selector
required
string <= 2048 characters

A boolean string or JQ expression that must evaluate to a boolean value. Supports JQ expressions syntax on discovered entity's integration_record property.

required
IgnoreAction (object) or MapAction (object) (SuggestedRuleAction)
required
object

JSON object that may contain additional context about the entity.

Responses

Request samples

Content type
application/json
{
  • "binding": "pagerduty_service",
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "integration_record": {
    }
}

Response samples

Content type
application/json
{
  • "evaluation": {
    },
  • "errors": [
    ]
}

Suggested Discovery Actions

List Suggested Discovery Actions

Returns a paginated collection of a suggested discovery actions.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (SuggestedDiscoveryActionFilterParameters)

Filters a collection of suggested discovery actions.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of suggested discovery actions. Supported sort attributes are:

  • created_at
  • updated_at

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Fetch Suggested Discovery Action

Returns information about a suggested discovery action.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
suggestedDiscoveryActionId
required
string <uuid>
Example: 76ca0689-f08e-4c04-b2a6-4c992d89d554

ID of the suggested discovery action.

Responses

Response samples

Content type
application/json
{
  • "id": "76ca0689-f08e-4c04-b2a6-4c992d89d554",
  • "integration": "gateway-manager",
  • "suggestion_rule_id": "22f72bd1-2897-473e-9471-302de3ccf38b",
  • "discovered_entity_id": "287ead32-a7da-4f2e-89cb-802ae6208f18",
  • "entity_name": "My Service",
  • "scope": "service",
  • "service_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "ignored": false,
  • "action": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Update Suggested Discovery Action

Updates the given suggested discovery.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
suggestedDiscoveryActionId
required
string <uuid>
Example: 76ca0689-f08e-4c04-b2a6-4c992d89d554

ID of the suggested discovery action.

Request Body schema: application/json

Request body schema for updating a suggested discovery action.

ignored
required
boolean

Determines if this suggested action has been ignored or not.

  • true: Suggested action has been ignored
  • false: Suggested action is ready to be accepted or ignored

Responses

Request samples

Content type
application/json
{
  • "ignored": false
}

Response samples

Content type
application/json
{
  • "id": "76ca0689-f08e-4c04-b2a6-4c992d89d554",
  • "integration": "gateway-manager",
  • "suggestion_rule_id": "22f72bd1-2897-473e-9471-302de3ccf38b",
  • "discovered_entity_id": "287ead32-a7da-4f2e-89cb-802ae6208f18",
  • "entity_name": "My Service",
  • "scope": "service",
  • "service_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "ignored": false,
  • "action": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Discovery Actions

Create Discovery Action

Creates a discovery action.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
Request Body schema: application/json

Request body schema for creating a service discovery action.

discovered_entity_id
required
string <uuid>

The identifier of the discovered entity associated to this discovery action.

required
CreateAndMapServiceActionPayload (object) or IgnoreAction (object) or RestoreAction (object) or MapServiceAction (object)

Responses

Request samples

Content type
application/json
{
  • "discovered_entity_id": "287ead32-a7da-4f2e-89cb-802ae6208f18",
  • "action": {
    }
}

Response samples

Content type
application/json
{
  • "id": "76ca0689-f08e-4c04-b2a6-4c992d89d554",
  • "discovered_entity_id": "287ead32-a7da-4f2e-89cb-802ae6208f18",
  • "entity_name": "My Service",
  • "action": {
    },
  • "user_id": "699f1021-4ed8-4f97-8ed3-779fba89d9c7",
  • "cause": "user-action",
  • "integration": "gateway-manager",
  • "outputs": { },
  • "created_at": "2022-03-30T07:20:50Z"
}

List Discovery Actions

Returns a paginated collection of discovery actions.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[before]
string
Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item before this parameter.

page[after]
string
Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item after this parameter.

page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

object (DiscoveryActionFilterParameters)

Filters a collection of discovery actions.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of discovery actions. Supported sort attributes are:

  • created_at

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Fetch Discovery Actions

Returns information about a discovery action.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
discoveryActionId
required
string <uuid>
Example: ffa82ca6-3753-42d9-a69e-65e02dd9d9a1

ID of the discovery action.

Responses

Response samples

Content type
application/json
{
  • "id": "76ca0689-f08e-4c04-b2a6-4c992d89d554",
  • "discovered_entity_id": "287ead32-a7da-4f2e-89cb-802ae6208f18",
  • "entity_name": "My Service",
  • "action": {
    },
  • "user_id": "699f1021-4ed8-4f97-8ed3-779fba89d9c7",
  • "cause": "user-action",
  • "integration": "gateway-manager",
  • "outputs": { },
  • "created_at": "2022-03-30T07:20:50Z"
}

Discovery Ingestion

Schedule Discovery Ingestion

Schedules a discovery ingestion job for the given integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for scheduling a discovery ingestion job.

ingest_from
string <date-time>

A timestamp indicating when to start ingestion from. RFC-3339 format is used with a "T" character separating date from time within the field value. Omitting this property indicates ingestion will be triggered from the beginning of time until the present.

Responses

Request samples

Content type
application/json
{
  • "ingest_from": "2023-02-15T07:20:50Z"
}

Response samples

Content type
application/json
{
  • "last_scheduled": "2023-02-15T07:20:50Z"
}

Fetch Discovery Ingestion Status

Fetches the status of discovery ingestion for the given integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Responses

Response samples

Content type
application/json
{
  • "last_scheduled": "2023-02-15T07:20:50Z"
}

Metadata Field

List Metadata Schemas

Returns a paginated collection of metadata schemas.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (MetadataSchemaFilterParameters)

Filters a collection of metadata schemas.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of metadata schemas. Supported sort attributes are:

  • created_at
  • updated_at
  • name

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}