Create or update an environment

PUT

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

Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "Environments."

Note: To create or update name patterns that branches must match in order to deploy to this environment, see "Deployment branch policies."

Note: To create or update secrets for an environment, see "GitHub Actions secrets."

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

リクエストパラメータ

パスパラメータ

リクエストボディパラメータapplication/json

例

レスポンス

🟢200OK

application/json

Response

ボディapplication/json

🟠422Parameter Error

リクエストExample

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://service1.exmaple.com/repos///environments/' \
--header 'Content-Type: application/json' \
--data '{
    "wait_timer": 30,
    "reviewers": [
        {
            "type": "User",
            "id": 1
        },
        {
            "type": "Team",
            "id": 1
        }
    ],
    "deployment_branch_policy": {
        "protected_branches": false,
        "custom_branch_policies": true
    }
}'

レスポンスExample

200 - default

{
    "id": 161088068,
    "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4",
    "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": 3736,
            "node_id": "MDQ6R2F0ZTM3MzY=",
            "type": "wait_timer",
            "wait_timer": 30
        },
        {
            "id": 3755,
            "node_id": "MDQ6R2F0ZTM3NTU=",
            "type": "required_reviewers",
            "reviewers": [
                {
                    "type": "User",
                    "reviewer": {
                        "login": "octocat",
                        "id": 1,
                        "node_id": "MDQ6VXNlcjE=",
                        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
                        "gravatar_id": "",
                        "url": "https://api.github.com/users/octocat",
                        "html_url": "https://github.com/octocat",
                        "followers_url": "https://api.github.com/users/octocat/followers",
                        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
                        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
                        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
                        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
                        "organizations_url": "https://api.github.com/users/octocat/orgs",
                        "repos_url": "https://api.github.com/users/octocat/repos",
                        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
                        "received_events_url": "https://api.github.com/users/octocat/received_events",
                        "type": "User",
                        "site_admin": false
                    }
                },
                {
                    "type": "Team",
                    "reviewer": {
                        "id": 1,
                        "node_id": "MDQ6VGVhbTE=",
                        "url": "https://api.github.com/teams/1",
                        "html_url": "https://github.com/orgs/github/teams/justice-league",
                        "name": "Justice League",
                        "slug": "justice-league",
                        "description": "A great team.",
                        "privacy": "closed",
                        "permission": "admin",
                        "members_url": "https://api.github.com/teams/1/members{/member}",
                        "repositories_url": "https://api.github.com/teams/1/repos",
                        "parent": null
                    }
                }
            ]
        },
        {
            "id": 3756,
            "node_id": "MDQ6R2F0ZTM3NTY=",
            "type": "branch_policy"
        }
    ],
    "deployment_branch_policy": {
        "protected_branches": false,
        "custom_branch_policies": true
    }
}

更新日時 2025-06-12 06:47:19

Get an environment

Delete an environment