v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB

repos

Get an environment

[!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.

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

Path parameters

ownerstring required

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

repostring required

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

environment_namestring required

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

Response

idinteger required

The id of the environment.

node_idstring required

namestring required

The name of the environment.

urlstring required

html_urlstring required

created_atstring date-time required

The time that the environment was created, in ISO 8601 format.

updated_atstring date-time required

The time that the environment was last updated, in ISO 8601 format.

Example response

{
  "id": 56780428,
  "node_id": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=",
  "name": "staging",
  "url": "https://api.github.com/repos/github/hello-world/environments/staging",
  "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging",
  "created_at": "2020-11-23T22:00:40Z",
  "updated_at": "2020-11-23T22:00:40Z",
  "protection_rules": [
    {
      "id": 3515,
      "node_id": "MDQ6R2F0ZTM1MTU=",
      "type": "wait_timer",
      "wait_timer": 30
    }
  ]
}