Skip to content

Latest commit

 

History

History
170 lines (96 loc) · 5.53 KB

SecretsApi.md

File metadata and controls

170 lines (96 loc) · 5.53 KB

\SecretsApi

All URIs are relative to https://chaos.qernal.com/v1

Method HTTP request Description
projects_secrets_create POST /projects/{project_id}/secrets Create project secret
projects_secrets_delete DELETE /projects/{project_id}/secrets/{secret_name} Delete project secret
projects_secrets_get GET /projects/{project_id}/secrets/{secret_name} Get project secret
projects_secrets_list GET /projects/{project_id}/secrets List project secrets of a specific type
projects_secrets_update PUT /projects/{project_id}/secrets/{secret_name} Update project secret

projects_secrets_create

models::SecretResponse projects_secrets_create(project_id, secret_body) Create project secret

Create a new project secret

Parameters

Name Type Description Required Notes
project_id uuid::Uuid Project ID reference [required]
secret_body SecretBody Create/Update any field The example generated may only be for one of the secret types, look towards the payload section of the schema for further fields, values and examples. [required]

Return type

models::SecretResponse

Authorization

cookie, token

HTTP request headers

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

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

projects_secrets_delete

models::DeletedResponse projects_secrets_delete(project_id, secret_name) Delete project secret

Delete project secret, if the secret is still linked to an active/deployed function - it cannot be removed

Parameters

Name Type Description Required Notes
project_id uuid::Uuid Project ID reference [required]
secret_name String Unique secret name [required]

Return type

models::DeletedResponse

Authorization

cookie, token

HTTP request headers

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

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

projects_secrets_get

models::SecretMetaResponse projects_secrets_get(project_id, secret_name) Get project secret

Get a specific project

Parameters

Name Type Description Required Notes
project_id uuid::Uuid Project ID reference [required]
secret_name String Unique secret name [required]

Return type

models::SecretMetaResponse

Authorization

cookie, token

HTTP request headers

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

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

projects_secrets_list

models::ListSecretResponse projects_secrets_list(project_id, page, secret_type) List project secrets of a specific type

List project secrets of a specific type

Parameters

Name Type Description Required Notes
project_id uuid::Uuid Project ID reference [required]
page Option<OrganisationsListPageParameter> Query parameters for pagination
secret_type Option<SecretMetaType> Type of secret to filter on

Return type

models::ListSecretResponse

Authorization

cookie, token

HTTP request headers

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

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

projects_secrets_update

models::SecretResponse projects_secrets_update(project_id, secret_name, secret_body_patch) Update project secret

Update project

Parameters

Name Type Description Required Notes
project_id uuid::Uuid Project ID reference [required]
secret_name String Unique secret name [required]
secret_body_patch SecretBodyPatch Update any field [required]

Return type

models::SecretResponse

Authorization

cookie, token

HTTP request headers

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

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