idstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Get an Integration Instance
Fetches a integration instance.
get
Path Parameters
Response
application/json
Response
application/json
A response containing a single integration instance object.
IntegrationInstance
Information about an integration instance.
idstring(uuid)requiredread-only
The integration instance ID.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
namestringrequired
The machine name of the integration instance that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:aws-lambda-prod
display_namestringrequired
The display name of the integration instance.
>= 1 characters<= 120 characters
Example:AWS (prod)
descriptionstring | nullrequired
The description of the integration instance.
<= 2048 characters
integrationobjectrequired
Short-hand descriptor of an integration that omits instance metadata.
Show Child Parameters
authorizedbooleanrequiredread-only
Denotes whether the integration instance has been authorized within the catalog.
Example:true
configobjectrequired
JSON object representing configuration specific to the integration instance.
The expected schema depends on the integration type and is dynamically registered at runtime.
Default:{}
Example:{"account_region":"eu"}
* Additional properties are allowed.
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
get/integration-instances/{id}
Authentication
Path Parameters
application/json
Update Integration Instance
Updates an integration instance.
patch
Path Parameters
idstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Body
application/json
Body
application/json
UpdateIntegrationInstance
* Additional properties are NOT allowed.
namestring
The machine name of the integration instance that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:aws-lambda-prod
display_namestring
The display name of the integration instance.
>= 1 characters<= 120 characters
Example:AWS (prod)
descriptionstring | null
Optionally provide a description of the integration instance.
<= 2048 characters
configobject
JSON object representing configuration specific to the integration instance.
The expected schema depends on the integration type and is dynamically registered at runtime.
Default:{}
Example:{"account_region":"eu"}
* Additional properties are allowed.
Response
application/json
Response
application/json
A response containing a single integration instance object.
IntegrationInstance
Information about an integration instance.
idstring(uuid)requiredread-only
The integration instance ID.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
namestringrequired
The machine name of the integration instance that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:aws-lambda-prod
display_namestringrequired
The display name of the integration instance.
>= 1 characters<= 120 characters
Example:AWS (prod)
descriptionstring | nullrequired
The description of the integration instance.
<= 2048 characters
integrationobjectrequired
Short-hand descriptor of an integration that omits instance metadata.
Show Child Parameters
authorizedbooleanrequiredread-only
Denotes whether the integration instance has been authorized within the catalog.
Example:true
configobjectrequired
JSON object representing configuration specific to the integration instance.
The expected schema depends on the integration type and is dynamically registered at runtime.
Default:{}
Example:{"account_region":"eu"}
* Additional properties are allowed.
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
patch/integration-instances/{id}
Authentication
Path Parameters
Body
{
"name": "swaggerhub-internal",
"display_name": "SwaggerHub (Internal)",
"description": "Swaggerhub account which hosts internal APIs only.",
"config": {}
}
application/json
Delete Integration Instance
Deletes an integration instance.
delete
Path Parameters
idstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Response
Response
Integration Instance was deleted successfully.
delete/integration-instances/{id}
Authentication
Path Parameters
Integration Instance Auth Credentials
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.
Create Integration Instance Auth Credential
Creates an auth credential scoped to the given integration instance.
Auth credentials are singleton resources that have a 1-to-1 relationship with
an integration instance.
An attempt to create subsequent auth credentials for an instance will result in a 409 response.
post
Path Parameters
integrationInstanceIdstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Body
application/json
Body
application/json
CreateIntegrationInstanceAuthCredential
CreateIntegrationInstanceAuthCredential
One Oftypestringrequired
Allowed values:oauth
configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Response
application/json
Response
application/json
A response containing an integration instance auth credential.
IntegrationInstanceAuthCredential
IntegrationInstanceAuthCredential
Object containing metadata for an integration instance auth credential.
One Ofidstring(uuid)required
Example:4f535923-ec24-456c-b4e5-e67f65c8c208
integration_instanceobjectrequired
Short-hand descriptor of an integration instance.
Show Child Parameters
missing_permissionsarray[object]required
List of detected missing permissions required to enable the full functionality of the given integration instance.
Show Child Parameters
taintedbooleanrequired
Indicates that the credential is no longer valid and must be replaced with a new valid credential.
Example:false
expires_atstring | null(date-time)required
Timestamp denoting when the when the credential will expire in RFC-3339 format with a “T” character separating date from time within the field value.
When expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance.
A null value indicates no known expiration time.
Example:2025-04-01T07:20:50Z
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
typestringrequired
Allowed values:oauth
post/integration-instances/{integrationInstanceId}/auth-credential
Authentication
Path Parameters
Body
{
"type": "multi_key_auth",
"config": {
"headers": [
{
"name": "authorization",
"key": "swaggerhub-api-key"
}
]
}
}
application/json