GET /repos/{owner}/{repo}/environments/{environment_name}

[!NOTE] To get information about name patterns that branches must match in order to deploy to this environment, see "Get a deployment branch policy."

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

Servers

Path parameters

Name Type Required Description
repo String Yes

The name of the repository without the .git extension. The name is not case sensitive.

environment_name String Yes

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

owner String Yes

The account owner of the repository. The name is not case sensitive.

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.