Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Integration Instance Auth Credentials API

Represents the credentials use to authorize an integration instance.You will want to configure the integration instance settings and authorization configuration before authorizing the instance.This will inform the authorization process on how to reach and authorize the account.Once the integration instance is authorized, the system will automatically discover all the relevant resources from the account.The integration instance's auth credentials can be removed or updated while retaining all resources which have already been discovered.

Kong Integration Instance Auth Credentials API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Integration Instance Auth Credentials. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 3 operations across 1 path, and defines 26 schemas. It is described by OpenAPI 3.1.0, at version 3.14.0.

Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.

3 operations 1 paths 26 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Integration Instance Auth Credentials API declares 1 security scheme for authenticating requests. An API key is passed in the header as Kong-Admin-Token (adminToken). By default, every request must be authenticated.

Paths & Operations 3

Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Integration Instance Auth Credentials 3

Represents the credentials use to authorize an integration instance. You will want to configure the integration instance settings and authorization configuration before authorizin…

POST
/v1/integration-instances/{integrationInstanceId}/auth-credential
Create Integration Instance Auth Credential
create-integration-instance-auth-credential 1 param body → 201400401403404409
GET
/v1/integration-instances/{integrationInstanceId}/auth-credential
Get Integration Instance Auth Credential
get-integration-instance-auth-credential 1 param → 200401403404
DELETE
/v1/integration-instances/{integrationInstanceId}/auth-credential
Delete Integration Instance Auth Credential
delete-integration-instance-auth-credential 1 param → 204401403404

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are AWSRoleDelegationAuthCredential (8 properties), GitHubAppInstallationCredential (8 properties), MultiKeyAuthCredential (7 properties), OAuthCredential (7 properties). Each schema is shown below with its type and property counts.

OAuthCredential
object
Represents a credential scoped to an integration instance that supports the OAuth authorization strategy.
7 properties 7 required
InvalidParameterMinimumLength
object
5 properties 4 required
MultiKeyAuthCredential
object
Represents a credential scoped to an integration instance that supports the Multi Key authorization strategy.
7 properties 7 required
InvalidParameterChoiceItem
object
5 properties 4 required
ConflictError
InvalidParameterMaximumLength
object
5 properties 4 required
IntegrationInstanceRef
object
Short-hand descriptor of an integration instance.
3 properties 3 required
MissingPermission
object
2 properties 2 required
CreateOAuthCredential
object
Payload used to create an OAuth credential for an integration instance.
2 properties 2 required
ForbiddenError
UnauthorizedError
CreateMultiKeyAuthCredential
object
Payload used to create an Multi Key credential for an integration instance.
2 properties 2 required
CreateIntegrationInstanceAuthCredential
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties 4 required
IntegrationInstanceAuthCredential
Object containing metadata for an integration instance auth credential.
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
GitHubAppInstallationCredential
object
Represents a credential scoped to an integration instance that supports the GitHub App Installation authorization strategy.
8 properties 8 required
CreateAWSRoleDelegationAuthCredential
object
Payload used to create an AWS Role Delegation credential for an integration instance.
2 properties 2 required
CreateGitHubAppInstallationCredential
object
Payload used to create an GitHub App Installation credential for an integration instance.
2 properties 2 required
NotFoundError
AWSRoleDelegationAuthCredential
object
Represents a credential scoped to an integration instance that supports the AWS Role Delegation authorization strategy.
8 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-integration-instance-auth-credentials-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API