Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Scope Configurations

Set Scope Config

Set or update the custom OPAL Scope config for a given environment.

put/v2/projects/{proj_id}/{env_id}/opal_scope

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Request body

Response

Successful Response

idstring uuid required

Unique id of the ScopeConfig

organization_idstring uuid required

Unique id of the organization that the ScopeConfig belongs to.

project_idstring uuid required

Unique id of the project that the ScopeConfig belongs to.

environment_idstring uuid required

Unique id of the environment that the ScopeConfig belongs to.

created_atstring date-time required

Date and time when the ScopeConfig was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the ScopeConfig was last updated/modified (ISO_8601 format).