ESescape
Integrations

Update Azure Boards integration.

Update a Azure Boards integration.

put/integrations/azure-boards/{id}

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

idstring uuid required

The integration ID

Example:00000000-0000-0000-0000-000000000000

Request body

namestring

The new name of the integration

proxyIdstring uuid nullable

Optional proxy ID to attach to the integration. Send null to detach the current location.

projectIdsstring[]

Optional list of project IDs to attach to the integration

tagsstring[]

Optional list of tag IDs to attach to the integration

Example request

{
  "proxyId": "00000000-0000-0000-0000-000000000000",
  "projectIds": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001"
  ],
  "tags": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001"
  ]
}

Response

OK

idstring uuid required

The id of the integration

namestring required

The name of the integration

createdAtstring date-time required

The date and time the integration was created

updatedAtstring date-time required

The date and time the integration was last updated

scheduledForDeletionAtstring date-time nullable required

The date and time the integration is scheduled for deletion

lastPullWorkflowAtstring date-time nullable required

The date and time the last pull workflow was executed

lastValidationAtstring date-time nullable required

The date and time the integration was last validated

invalidatedAtstring date-time nullable required

The date and time the integration was invalidated

kind'AKAMAI' | 'AWS' | 'AWS_ACCOUNT' | 'AZURE' | 'AZURE_BOARDS' | 'AZURE_KEY_VAULT' | 'BITBUCKET_REPO' | 'CLOUDFLARE' | 'CUSTOM' | 'DISCORD_WEBHOOK' | 'DNS' | 'EMAIL' | 'GCP' | 'GITHUB_API_KEY' | 'GITLAB_API_KEY' | 'JIRA' | 'KUBERNETES' | 'POSTMAN_API_KEY' | 'SERVICENOW' | 'SLACK_WEBHOOK' | 'TEAMS_WEBHOOK' | 'WEBHOOK' | 'WIZ' required

The kind of the integration

validboolean required

Whether the integration is valid

validationErrorsstring[] required

The validation errors of the integration

parametersunknown
metaunknown
organizationIdstring uuid required

The id of the organization the integration belongs to

proxyIdstring uuid nullable required

The id of the location used by the integration

Changes

No recorded changes to this operation across all 1 revision of this API.