Protected environments

Use this API to manage protected environments for a project, and protected environments for a group for a group.

The project endpoints require CI/CD to be turned on for the project. If CI/CD is turned off, requests return 403 Forbidden, even for users who otherwise have permission to manage protected environments.

List protected environments for a group

GET /api/v4/groups/{id}/protected_environments

Lists the protected environments configured for a group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProtectedEnvironment
`400`	Bad Request	—
`404`	Not Found	—

Create a protected environment for a group

POST /api/v4/groups/{id}/protected_environments

Creates a protected environment and its nested configuration for a group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`approval_rules_attributes`	Array of objects	—
`approval_rules_attributes[]._destroy`	Boolean	—
`approval_rules_attributes[].access_level`	Integer	Example: `40`
`approval_rules_attributes[].group_id`	Integer	Example: `3`
`approval_rules_attributes[].group_inheritance_type`	Integer	Allowed values: `0`, `1`
`approval_rules_attributes[].id`	Integer	Example: `1`
`approval_rules_attributes[].required_approvals`	Integer	Example: `1`
`approval_rules_attributes[].user_id`	Integer	Example: `2`
`deploy_access_levels_attributes`	Array of objects	—
`deploy_access_levels_attributes[]._destroy`	Boolean	—
`deploy_access_levels_attributes[].access_level`	Integer	Example: `40`
`deploy_access_levels_attributes[].group_id`	Integer	Example: `3`
`deploy_access_levels_attributes[].group_inheritance_type`	Integer	Allowed values: `0`, `1`
`deploy_access_levels_attributes[].id`	Integer	Example: `1`
`deploy_access_levels_attributes[].user_id`	Integer	Example: `2`
`name` Required	String	Allowed values: `production`, `staging`, `testing`, `development`, `other` Minimum length: `1`
`required_approval_count`	Integer	Example: `0`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProtectedEnvironment
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a protected environment for a group

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

Retrieves a protected environment configured for a group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`
`name` Path, required	String	Allowed values: `production`, `staging`, `testing`, `development`, `other` Minimum length: `1` Example: `production`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProtectedEnvironment
`400`	Bad Request	—
`404`	Not Found	—

Update nested protected environment configuration for a group

PUT /api/v4/groups/{id}/protected_environments/{name}

Updates nested configuration without changing the protected environment name.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`
`name` Path, required	String	Allowed values: `production`, `staging`, `testing`, `development`, `other` Minimum length: `1` Example: `production`

Request body (application/json)

Property	Type	Description
`approval_rules_attributes`	Array of objects	—
`approval_rules_attributes[]._destroy`	Boolean	—
`approval_rules_attributes[].access_level`	Integer	Example: `40`
`approval_rules_attributes[].group_id`	Integer	Example: `3`
`approval_rules_attributes[].group_inheritance_type`	Integer	Allowed values: `0`, `1`
`approval_rules_attributes[].id`	Integer	Example: `1`
`approval_rules_attributes[].required_approvals`	Integer	Example: `1`
`approval_rules_attributes[].user_id`	Integer	Example: `2`
`deploy_access_levels_attributes`	Array of objects	—
`deploy_access_levels_attributes[]._destroy`	Boolean	—
`deploy_access_levels_attributes[].access_level`	Integer	Example: `40`
`deploy_access_levels_attributes[].group_id`	Integer	Example: `3`
`deploy_access_levels_attributes[].group_inheritance_type`	Integer	Allowed values: `0`, `1`
`deploy_access_levels_attributes[].id`	Integer	Example: `1`
`deploy_access_levels_attributes[].user_id`	Integer	Example: `2`
`required_approval_count`	Integer	Example: `0`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProtectedEnvironment
`400`	Bad Request	—
`404`	Not Found	—

Delete a protected environment from a group

DELETE /api/v4/groups/{id}/protected_environments/{name}

Deletes a protected environment and its nested configuration from a group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`
`name` Path, required	String	Allowed values: `production`, `staging`, `testing`, `development`, `other` Minimum length: `1` Example: `production`

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`404`	Not Found	—

List protected environments for a project

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

Lists the protected environments configured for a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProtectedEnvironment
`400`	Bad Request	—
`404`	Not Found	—

Create a protected environment for a project

POST /api/v4/projects/{id}/protected_environments

Creates a protected environment and its nested configuration for a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`approval_rules_attributes`	Array of objects	—
`approval_rules_attributes[]._destroy`	Boolean	—
`approval_rules_attributes[].access_level`	Integer	Example: `40`
`approval_rules_attributes[].group_id`	Integer	Example: `3`
`approval_rules_attributes[].group_inheritance_type`	Integer	Allowed values: `0`, `1`
`approval_rules_attributes[].id`	Integer	Example: `1`
`approval_rules_attributes[].required_approvals`	Integer	Example: `1`
`approval_rules_attributes[].user_id`	Integer	Example: `2`
`deploy_access_levels_attributes`	Array of objects	—
`deploy_access_levels_attributes[]._destroy`	Boolean	—
`deploy_access_levels_attributes[].access_level`	Integer	Example: `40`
`deploy_access_levels_attributes[].group_id`	Integer	Example: `3`
`deploy_access_levels_attributes[].group_inheritance_type`	Integer	Allowed values: `0`, `1`
`deploy_access_levels_attributes[].id`	Integer	Example: `1`
`deploy_access_levels_attributes[].user_id`	Integer	Example: `2`
`name` Required	String	Example: `production`
`required_approval_count`	Integer	Example: `0`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProtectedEnvironment
`400`	Bad Request	—
`404`	Not Found	—

List inherited protected environments for a project

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

Lists protected environments inherited from the project group hierarchy.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesInheritedProtectedEnvironment
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a protected environment for a project

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

Retrieves a protected environment configured for a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`name` Path, required	String	Example: `production`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProtectedEnvironment
`400`	Bad Request	—
`404`	Not Found	—

Update nested protected environment configuration for a project

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

Updates nested configuration without changing the protected environment name.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`name` Path, required	String	Example: `production`

Request body (application/json)

Property	Type	Description
`approval_rules_attributes`	Array of objects	—
`approval_rules_attributes[]._destroy`	Boolean	—
`approval_rules_attributes[].access_level`	Integer	Example: `40`
`approval_rules_attributes[].group_id`	Integer	Example: `3`
`approval_rules_attributes[].group_inheritance_type`	Integer	Allowed values: `0`, `1`
`approval_rules_attributes[].id`	Integer	Example: `1`
`approval_rules_attributes[].required_approvals`	Integer	Example: `1`
`approval_rules_attributes[].user_id`	Integer	Example: `2`
`deploy_access_levels_attributes`	Array of objects	—
`deploy_access_levels_attributes[]._destroy`	Boolean	—
`deploy_access_levels_attributes[].access_level`	Integer	Example: `40`
`deploy_access_levels_attributes[].group_id`	Integer	Example: `3`
`deploy_access_levels_attributes[].group_inheritance_type`	Integer	Allowed values: `0`, `1`
`deploy_access_levels_attributes[].id`	Integer	Example: `1`
`deploy_access_levels_attributes[].user_id`	Integer	Example: `2`
`required_approval_count`	Integer	Example: `0`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProtectedEnvironment
`400`	Bad Request	—
`404`	Not Found	—

Delete a protected environment from a project

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

Deletes a protected environment and its nested configuration from a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`name` Path, required	String	Example: `production`

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`404`	Not Found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesInheritedProtectedEnvironment

Property	Type	Description
`approval_rules`	Array of APIEntitiesProtectedEnvironmentApprovalRule	—
`deploy_access_levels`	Array of APIEntitiesProtectedEnvironmentAccessLevel	—
`group`	APIEntitiesProtectedEnvironmentOwnerGroup	—
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `production`
`required_approval_count`	Integer	Example: `0`

APIEntitiesProtectedEnvironment

Property	Type	Description
`approval_rules`	Array of APIEntitiesProtectedEnvironmentApprovalRule	—
`deploy_access_levels`	Array of APIEntitiesProtectedEnvironmentAccessLevel	—
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `production`
`required_approval_count`	Integer	Example: `0`

APIEntitiesProtectedEnvironmentAccessLevel

Property	Type	Description
`access_level`	Integer	Example: `40`
`access_level_description`	String	Example: `Maintainers`
`group_id`	Integer (int64)	Example: `3`
`group_inheritance_type`	Integer	Example: `0`
`id`	Integer (int64)	Example: `1`
`user_id`	Integer (int64)	Example: `2`

APIEntitiesProtectedEnvironmentApprovalRule

Property	Type	Description
`access_level`	Integer	Example: `40`
`access_level_description`	String	Example: `Maintainers`
`group_id`	Integer (int64)	Example: `3`
`group_inheritance_type`	Integer	Example: `0`
`id`	Integer (int64)	Example: `1`
`required_approvals`	Integer	Example: `1`
`user_id`	Integer (int64)	Example: `2`

APIEntitiesProtectedEnvironmentOwnerGroup

Property	Type	Description
`full_name`	String	Example: `Platform`
`full_path`	String	Example: `platform`
`id`	Integer (int64)	Example: `1`
`web_path`	String	Example: `/groups/platform`

List protected environments for a group

Create a protected environment for a group

Retrieve a protected environment for a group

Update nested protected environment configuration for a group

Delete a protected environment from a group

List protected environments for a project

Create a protected environment for a project

List inherited protected environments for a project

Retrieve a protected environment for a project

Update nested protected environment configuration for a project

Delete a protected environment from a project

Schemas

APIEntitiesInheritedProtectedEnvironment

APIEntitiesProtectedEnvironment

APIEntitiesProtectedEnvironmentAccessLevel

APIEntitiesProtectedEnvironmentApprovalRule

APIEntitiesProtectedEnvironmentOwnerGroup

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC Compliance Report

Thank you

Error