API docs by Redocly

Konnect API Builder (3.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

The management API for building APIs for Konnect Dev Portals.

API

Create API

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Creates an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters

The name of your API. The name + version combination must be unique for each API you publish.

description
string or null

A description of your API. Will be visible on your live Portal.

version
string or null [ 1 .. 255 ] characters

An optional version for your API. Leave this empty if your API is unversioned.

deprecated
boolean
Default: false

Marks this API as deprecated.

slug
string or null^[\w-]+$

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

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 (PublicLabels) <= 50 properties

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

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

Responses

Request samples

Content type
application/json
Example
{
  • "name": "myAPI"
}

Response samples

Content type
application/json
{
  • "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  • "name": "myAPI",
  • "version": "v1",
  • "labels": {
    },
  • "public_labels": { },
  • "description": "My API",
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z",
  • "slug": "my-api-v1",
  • "portals": [
    ]
}

List APIs

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Returns a collection of all APIs.

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 (API Filter Parameters)

Filters APIs in the response.

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

Sorts a collection of APIs. Supported sort attributes are:

  • name
  • version
  • created_at
  • updated_at

Responses

Response samples

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

Fetch API

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Fetches an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

Responses

Response samples

Content type
application/json
{
  • "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  • "name": "myAPI",
  • "version": "v1",
  • "labels": {
    },
  • "public_labels": { },
  • "description": "My API",
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z",
  • "slug": "my-api-v1",
  • "portals": [
    ]
}

Update API

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Updates an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

Request Body schema: application/json
name
string [ 1 .. 255 ] characters

The name of your API. The name + version combination must be unique for each API you publish.

description
string or null

A description of your API. Will be visible on your live Portal.

version
string or null [ 1 .. 255 ] characters

An optional version for your API. Leave this empty if your API is unversioned.

deprecated
boolean
Default: false

Marks this API as deprecated.

slug
string or null^[\w-]+$

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

object or null (LabelsUpdate) <= 50 properties

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

Labels are intended to store INTERNAL metadata.

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

object (PublicLabelsUpdate) <= 50 properties

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

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

Responses

Request samples

Content type
application/json
Example
{
  • "name": "new API name"
}

Response samples

Content type
application/json
{
  • "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  • "name": "myAPI",
  • "version": "v1",
  • "labels": {
    },
  • "public_labels": { },
  • "description": "My API",
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z",
  • "slug": "my-api-v1",
  • "portals": [
    ]
}

Delete API

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Deletes an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "ApiUnauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "ApiUnauthorized"
}

API Documentation

Create API Document

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Publish a new document attached to an API.

All configuration options may be provided in the frontmatter section of content. If you set values in both the POST request and in the frontmatter, the values in the POST request will take precedence.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

Request Body schema: application/json
content
required
string (API Document Content)

Raw markdown content to display in your Portal

title
string (API Document Title)

The title of the document. Used to populate the <title> tag for the page

slug
string (API Document Slug) ^[\w-]+$

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(title)

status
string (ApiDocumentStatus)
Default: "unpublished"
Enum: "published" "unpublished"

If status=published the document will be visible in your live portal

parent_document_id
string or null <uuid> (API Document Parent Document ID)

API Documents may be rendered as a tree of files.

Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.

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
Example
{
  • "slug": "api-document",
  • "status": "published",
  • "title": "API Document",
  • "content": "# API Document Header"
}

Response samples

Content type
application/json
{
  • "id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
  • "parent_document_id": null,
  • "title": "API Document",
  • "slug": "api-document",
  • "status": "published",
  • "content": "# API Document Header",
  • "labels": {
    },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

List API Documents

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Returns a collection of all documents for an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

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 (API Document Filter Parameters)

Filters API Documents in the response.

Responses

Response samples

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

Fetch API Document

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Returns a document for the API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

documentId
required
string <uuid>
Example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb

The document identifier related to the API

Responses

Response samples

Content type
application/json
{
  • "id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
  • "parent_document_id": null,
  • "title": "API Document",
  • "slug": "api-document",
  • "status": "published",
  • "content": "# API Document Header",
  • "labels": {
    },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update API Document

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Updates a document for an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

documentId
required
string <uuid>
Example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb

The document identifier related to the API

Request Body schema: application/json
content
string (API Document Content)

Raw markdown content to display in your Portal

title
string (API Document Title)

The title of the document. Used to populate the <title> tag for the page

slug
string (API Document Slug) ^[\w-]+$

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(title)

status
string (ApiDocumentStatus)
Default: "unpublished"
Enum: "published" "unpublished"

If status=published the document will be visible in your live portal

parent_document_id
string or null <uuid> (API Document Parent Document ID)

API Documents may be rendered as a tree of files.

Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.

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
Example
{
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "api-document",
  • "status": "published",
  • "title": "API Document"
}

Response samples

Content type
application/json
{
  • "id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
  • "parent_document_id": null,
  • "title": "API Document",
  • "slug": "api-document",
  • "status": "published",
  • "content": "# API Document Header",
  • "labels": {
    },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete API Documentation

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Removes a document from an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

documentId
required
string <uuid>
Example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb

The document identifier related to the API

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "ApiUnauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "ApiUnauthorized"
}

Move API Documentation

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

This api allows the user to move a document within the document tree using the parameters parent_document_id and index. If parent_document_id is not provided, the document will be placed at the top level of the document tree. index 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 parent_document_id: null 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.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

documentId
required
string <uuid>
Example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb

The document identifier related to the API

Request Body schema: application/json

move document

parent_document_id
string <uuid>

parent document id

index
integer

index of the document in the parent document's children

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": 401,
  • "title": "ApiUnauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "ApiUnauthorized"
}

API Specification

Create API Specification

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Creates a specification for an API. Note: You can only have one specification for an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

Request Body schema: application/json
content
required
string

The raw content of your API specification.

type
string (API Spec Type)
Enum: "oas3" "asyncapi"

The type of specification being stored. This allows us to render the specification correctly.

If this field is not set, it will be autodetected from content

Responses

Request samples

Content type
application/json
{
  • "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}",
  • "type": "oas3"
}

Response samples

Content type
application/json
{
  • "id": "7710d5c4-d902-410b-992f-18b814155b53",
  • "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}",
  • "type": "oas3",
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

List API Specifications

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Returns a list of specifications for an API. Note: You can only have one specification for an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

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 (API Spec Filter Parameters)

Filters API Specs in the response.

Responses

Response samples

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

Fetch API Specification

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Fetches the specification of an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

specId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The API specification identifier

Responses

Response samples

Content type
application/json
{
  • "id": "7710d5c4-d902-410b-992f-18b814155b53",
  • "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}",
  • "type": "oas3",
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update API Specification

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Updates the specification of an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

specId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The API specification identifier

Request Body schema: application/json
content
string

The raw content of your API specification.

type
string (API Spec Type)
Enum: "oas3" "asyncapi"

The type of specification being stored. This allows us to render the specification correctly.

If this field is not set, it will be autodetected from content

Responses

Request samples

Content type
application/json
{
  • "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.1\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}"
}

Response samples

Content type
application/json
{
  • "id": "7710d5c4-d902-410b-992f-18b814155b53",
  • "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}",
  • "type": "oas3",
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete API Specification

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Deletes the specification of an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

specId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The API specification identifier

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "ApiUnauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "ApiUnauthorized"
}

API Publication

Publish API

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Publish an API to a portal.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

The Portal identifier

Request Body schema: application/json
auto_approve_registrations
boolean (Auto Approve Registrations)

Whether the application registration auto approval on this portal for the api is enabled. If set to false, fallbacks on portal's auto_approve_applications value.

auth_strategy_ids
Array of strings or null <uuid> (API Publication Auth Strategy IDs) = 1 items

The auth strategy the API enforces for applications in the portal. Omitting this property means the portal's default application auth strategy will be used. Setting to null means the API will not require application authentication. DCR support for application registration is currently in development.

visibility
string (API Publication Visibility)
Default: "private"
Enum: "public" "private"

The visibility of the API in the portal. Public API publications do not require authentication to view and retrieve information about them. Private API publications require authentication to retrieve information about them.

Responses

Request samples

Content type
application/json
{
  • "auto_approve_registrations": true,
  • "auth_strategy_ids": [
    ],
  • "visibility": "public"
}

Response samples

Content type
application/json
{
  • "auto_approve_registrations": true,
  • "auth_strategy_ids": [
    ],
  • "visibility": "public",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Fetch Publication

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Retrieve an API's publication in a portal. If the API is not published to the portal, a 404 response is returned.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

The Portal identifier

Responses

Response samples

Content type
application/json
{
  • "auto_approve_registrations": true,
  • "auth_strategy_ids": [
    ],
  • "visibility": "public",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Publication

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Unpublish an API from a portal.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

The Portal identifier

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "ApiUnauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "ApiUnauthorized"
}

List Publications

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Returns a collection of all API Publications.

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 (API Publication Filter Parameters)

Filters API Publications in the response.

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

Sorts a collection of API publications. Supported sort attributes are:

  • portal_id
  • portal_name
  • api_id
  • api_name
  • created_at
  • updated_at

Responses

Response samples

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

API Implementation

Create API Implementation

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Creates an implementation for an API. An API can be implemented by a single Gateway Service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

Request Body schema: application/json
required
object (API Implementation Service)

A Gateway service that implements an API

Responses

Request samples

Content type
application/json
{
  • "service": {
    }
}

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "service": {
    }
}

Fetch API Implementation

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Retrieve a gateway implementation for this API

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

implementationId
required
string <uuid>
Example: 032d905a-ed33-46a3-a093-d8f536af9a8a

The Portal identifier

Responses

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "service": {
    }
}

Delete API Implementation

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Unlink a gateway implementation from this API

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

implementationId
required
string <uuid>
Example: 032d905a-ed33-46a3-a093-d8f536af9a8a

The Portal identifier

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "ApiUnauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "ApiUnauthorized"
}

List API Implementations

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

List gateway implementations for this API

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 (API Implementation Filter Parameters)

Filters APIs in the response.

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

Sorts a collection of API implementations. Supported sort attributes are:

  • id
  • api_id
  • control_plane_id
  • service_id
  • created_at
  • updated_at

Responses

Response samples

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