API integration

List API integrations

GET/api/v2/api-integrations
List API integrations

쿼리 매개 변수

매개 변수설명
like string
Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

응답

코드설명
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create an API integration

POST/api/v2/api-integrations
Create an API integration

쿼리 매개 변수

매개 변수설명
createMode string
Parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

응답

코드설명
200
Successful request.
202

Fetch an API integration

GET/api/v2/api-integrations/{name}
Fetch an API integration

경로 매개 변수

매개 변수설명
name string
Identifier (i.e. name) for the resource.

응답

코드설명
200
successful
202

Create an (or alter an existing) API integration

PUT/api/v2/api-integrations/{name}
Create an (or alter an existing) API integration. Note that API_KEY is not currently altered by this operation and is supported for a newly-created object only. Unsetting API_BLOCKED_PREFIXES is also unsupported.

응답

코드설명
200
202

Delete an API integration

DELETE/api/v2/api-integrations/{name}
Delete an API integration

쿼리 매개 변수

매개 변수설명
ifExists boolean
Parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

응답

코드설명
200
202