Skip to content

Latest commit

 

History

History
101 lines (57 loc) · 3.45 KB

ScopeConfigurationsApi.md

File metadata and controls

101 lines (57 loc) · 3.45 KB
Raw

\ScopeConfigurationsApi

All URIs are relative to http://localhost

Method HTTP request Description
get_scope_config GET /v2/projects/{proj_id}/{env_id}/opal_scope Get Scope Config
reset_scope_config DELETE /v2/projects/{proj_id}/{env_id}/opal_scope Reset Scope Config
set_scope_config PUT /v2/projects/{proj_id}/{env_id}/opal_scope Set Scope Config

get_scope_config

models::ScopeConfigRead get_scope_config(proj_id, env_id) Get Scope Config

Returns the custom OPAL Scope config for given environment, if exists. If not custom config is set, return 404.

Parameters

Name Type Description Required Notes
proj_id String Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). [required]
env_id String Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). [required]

Return type

models::ScopeConfigRead

Authorization

HTTPBearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reset_scope_config

reset_scope_config(proj_id, env_id) Reset Scope Config

Parameters

Name Type Description Required Notes
proj_id String Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). [required]
env_id String Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). [required]

Return type

(empty response body)

Authorization

HTTPBearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_scope_config

models::ScopeConfigRead set_scope_config(proj_id, env_id, scope_config_set) Set Scope Config

Parameters

Name Type Description Required Notes
proj_id String Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). [required]
env_id String Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). [required]
scope_config_set ScopeConfigSet [required]

Return type

models::ScopeConfigRead

Authorization

HTTPBearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]