API Key Connections

Stores and manages API keys for an integration. See Understanding connections.

JSON format

API Key Connections are represented as JSON objects with the following properties:

Name	Type	Read-only	Mandatory	Description
allowed_domain	string	false	true	Hostname the connection can be used on. See Allowed domain
api_key	string	false	true	API key. For security purposes, this value is redacted in responses
created_at	string	true	false	When the connection was created
header_name	string	false	true	Name of the HTTP header used to pass the API key in requests. See HTTP headers for API keys
name	string	false	true	Name used to uniquely identify the connection. See Connection names
updated_at	string	true	false	When the connection was last updated

Create API Key Connection

• POST /api/services/zis/integrations/{integration}/connections/api_key

Creates an API key connection for the integration.

Authentication

You can authorize requests using a ZIS OAuth access token. A Zendesk app can also authorize requests to this endpoint using an admin's browser session. See Making API requests from a Zendesk app.

Parameters

Name	Type	In	Required	Description
integration	string	Path	true	Name of the integration

Example body

{
  "allowed_domain": "api.example.com",
  "api_key": "MY_API_KEY",
  "header_name": "x-api-key",
  "name": "my_api_key_connection"
}

Using cURL

curl https://{subdomain}.zendesk.com/api/services/zis/integrations/{integration}/connections/api_key \
-H "Authorization: Bearer {access_token}" \
-X POST \
-H 'content-type: application/json' \
-d '{
  "name": "my_api_key_connection",
  "header_name": "x-api-key",
  "api_key": "MY_API_KEY",
  "allowed_domain": "api.example.com"
  }'

Example response(s)

201 Created

Status 201 Created

{
  "api_key": {
    "allowed_domain": "api.example.com",
    "api_key": "*****",
    "created_at": "1985-04-12T23:20:50.52Z",
    "header_name": "x-api-key",
    "name": "my_api_key_connection",
    "updated_at": "1985-04-12T23:20:50.52Z"
  }
}

400 Bad Request

Status 400 Bad Request

{
  "errors": [
    {
      "code": "InvalidIntegration",
      "title": "Specified integration is not valid"
    }
  ]
}

401 Unauthorized

Status 401 Unauthorized

{
  "errors": [
    {
      "code": "InvalidCredentials",
      "title": "Token length is invalid"
    }
  ]
}

403 Forbidden

Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "title": "Cannot access this resource. Missing scope write"
    }
  ]
}

409 Conflict

Status 409 Conflict

{
  "errors": [
    {
      "code": "Conflict",
      "title": "Resource conflict"
    }
  ]
}

429 Too Many Requests

Status 429 Too Many Requests

{
  "errors": [
    {
      "code": "TooManyRequests",
      "title": "Too many requests"
    }
  ]
}

Show API Key Connection

• GET /api/services/zis/integrations/{integration}/connections/api_key/{name}

Returns the details of an API key connection.

Authentication

You can authorize requests using a ZIS OAuth access token. A Zendesk app can also authorize requests to this endpoint using an admin's browser session. See Making API requests from a Zendesk app.

Parameters

Name	Type	In	Required	Description
integration	string	Path	true	Name of the integration
name	string	Path	true	Name of the API key connection

Using cURL

curl https://{subdomain}.zendesk.com/api/services/zis/integrations/{integration}/connections/api_key/{name} \
-H "Authorization: Bearer {access_token}"

Example response(s)

200 OK

Status 200 OK

{
  "api_key": {
    "allowed_domain": "api.example.com",
    "api_key": "*****",
    "created_at": "1985-04-12T23:20:50.52Z",
    "header_name": "x-api-key",
    "name": "my_api_key_connection",
    "updated_at": "1985-04-12T23:20:50.52Z"
  }
}

401 Unauthorized

Status 401 Unauthorized

{
  "errors": [
    {
      "code": "InvalidCredentials",
      "title": "Token length is invalid"
    }
  ]
}

403 Forbidden

Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "title": "Cannot access this resource. Missing scope write"
    }
  ]
}

404 Not Found

Status 404 Not Found

{
  "errors": [
    {
      "code": "NotFound",
      "title": "Connection does not exist"
    }
  ]
}

429 Too Many Requests

Status 429 Too Many Requests

{
  "errors": [
    {
      "code": "TooManyRequests",
      "title": "Too many requests"
    }
  ]
}

Update API Key Connection

• PATCH /api/services/zis/integrations/{integration}/connections/api_key/{name}

Updates an API key connection.

Authentication

You can authorize requests using a ZIS OAuth access token. A Zendesk app can also authorize requests to this endpoint using an admin's browser session. See Making API requests from a Zendesk app.

Parameters

Name	Type	In	Required	Description
integration	string	Path	true	Name of the integration
name	string	Path	true	Name of the API key connection

Example body

{
  "api_key": "MY_API_KEY",
  "header_name": "x-api-key"
}

Using cURL

curl https://{subdomain}.zendesk.com/api/services/zis/integrations/{integration}/connections/api_key/{name} \
-H "Authorization: Bearer {access_token}" \
-X PATCH \
-H 'content-type: application/json' \
-d '{
  "header_name": "x-api-key",
  "api_key": "MY_API_KEY"
  }'

Example response(s)

204 No Content

Status 204 No Content

400 Bad Request

Status 400 Bad Request

{
  "errors": [
    {
      "code": "InvalidIntegration",
      "title": "Specified integration is not valid"
    }
  ]
}

401 Unauthorized

Status 401 Unauthorized

{
  "errors": [
    {
      "code": "InvalidCredentials",
      "title": "Token length is invalid"
    }
  ]
}

403 Forbidden

Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "title": "Cannot access this resource. Missing scope write"
    }
  ]
}

404 Not Found

Status 404 Not Found

{
  "errors": [
    {
      "code": "NotFound",
      "title": "Connection does not exist"
    }
  ]
}

429 Too Many Requests

Status 429 Too Many Requests

{
  "errors": [
    {
      "code": "TooManyRequests",
      "title": "Too many requests"
    }
  ]
}

Delete API Key Connection

• DELETE /api/services/zis/integrations/{integration}/connections/api_key/{name}

Deletes an API key connection.

Authentication

You can authorize requests using a ZIS OAuth access token. A Zendesk app can also authorize requests to this endpoint using an admin's browser session. See Making API requests from a Zendesk app.

Parameters

Name	Type	In	Required	Description
integration	string	Path	true	Name of the integration
name	string	Path	true	Name of the API key connection

Using cURL

curl https://{subdomain}.zendesk.com/api/services/zis/integrations/{integration}/connections/api_key/{name} \
-H "Authorization: Bearer {access_token}" \
-X DELETE

Example response(s)

204 No Content

Status 204 No Content

401 Unauthorized

Status 401 Unauthorized

{
  "errors": [
    {
      "code": "InvalidCredentials",
      "title": "Token length is invalid"
    }
  ]
}

403 Forbidden

Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "title": "Cannot access this resource. Missing scope write"
    }
  ]
}

404 Not Found

Status 404 Not Found

{
  "errors": [
    {
      "code": "NotFound",
      "title": "Connection does not exist"
    }
  ]
}

429 Too Many Requests

Status 429 Too Many Requests

{
  "errors": [
    {
      "code": "TooManyRequests",
      "title": "Too many requests"
    }
  ]
}