GET /v13/deployments/{idOrUrl}

Retrieves information for a deployment either by supplying its ID (id property) or Hostname (url property). Additional details will be included when the authenticated user or team is an owner of the deployment.

Servers

Path parameters

Name Type Required Description
idOrUrl String Yes

The unique identifier or hostname of the deployment.

Query parameters

Name Type Required Description
withGitRepoInfo String No

When true, the response includes the gitSource object with the commit SHA, branch name, and connected repository metadata. Defaults to false.

teamId String No

The Team identifier to perform the request on behalf of.

slug String No

The Team slug to perform the request on behalf of.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.