Skip to content
forgit api docs

Retrieve a protected environment for a project

GET
/api/v4/projects/{id}/protected_environments/{name}

Retrieves a specified protected environment for a project.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
One of:
string

The ID or URL-encoded path of the project owned by the authenticated user

name
required
string

The name of the protected environment

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
name
string
deploy_access_levels
object
id
integer format: int64
access_level
integer
access_level_description
string
deploy_key_id
integer format: int64
user_id
integer format: int64
group_id
integer format: int64
member_role_id
integer format: int64
member_role_name
string
group_inheritance_type
integer
required_approval_count
integer
approval_rules
object
id
integer format: int64
user_id
integer format: int64
group_id
integer format: int64
access_level
integer
access_level_description
string
required_approvals
integer
group_inheritance_type
integer
Example 
{
  "name": "production",
  "deploy_access_levels": {
    "id": 1,
    "access_level": 40,
    "access_level_description": "Maintainers",
    "deploy_key_id": 1,
    "user_id": 1,
    "group_id": 1,
    "member_role_id": 42,
    "member_role_name": "Lead Developer",
    "group_inheritance_type": 0
  },
  "required_approval_count": 2
}

400

Section titled “ 400 ”

Bad Request

404

Section titled “ 404 ”

Not found