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. If the
repository is private, you must use an access token with the repo scope. GitHub
Apps must have the actions:read permission to use this endpoint.

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

Responses

🟢200Response

application/json

Body

Details of a deployment environment

created_at

string <date-time>

required

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

Example:

2020-11-23T22:00:40.000Z

deployment_branch_policy

object (deployment-branch-policy-settings) | null

optional

The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

custom_branch_policies

boolean

required

Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

protected_branches

boolean

required

Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

html_url

string

required

Example:

https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging

integer

required

The id of the environment.

Example:

56780428

name

string

required

The name of the environment.

Example:

staging

node_id

string

required

Example:

MDExOkVudmlyb25tZW50NTY3ODA0Mjg=

protection_rules

array [anyOf]

optional

object

optional

object

optional

object

optional

updated_at

string <date-time>

required

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

Example:

2020-11-23T22:00:40.000Z

url

string

required

Example:

https://api.github.com/repos/github/hello-world/environments/staging

Request

Responses