Skip to Content

Secrets

The secrets operations of the v1 API.

GET
/v1/clusters/{cluster_id}/secrets

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

List a cluster's secrets (metadata only, never values).

Ordered by creation time, oldest first. Cursor paginated.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid

Query Parameters

cursor?|

Opaque cursor from the previous page's next_cursor.

limit?|

Page size, 1 to 100 (default 25).

Formatuint
Range0 <= value

Response Body

A page of secrets

application/json
  1. response

One page of a v1 list.

data*array<>

The items, in the documented order.

has_more*boolean

Whether more items follow this page.

next_cursor?|

Pass as cursor to get the next page; null on the last page.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/secrets' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "description": "string",      "expires_at": "2019-08-24T14:15:22Z",      "has_value": true,      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "injection_mode": "string",      "keep_versions": 0,      "mount_path": "string",      "name": "string",      "rotated_at": "2019-08-24T14:15:22Z",      "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",      "scope_type": "string",      "secret_type": "string",      "updated_at": "2019-08-24T14:15:22Z",      "value_origin": "string",      "version": 0,      "write_only": true    }  ],  "has_more": true,  "next_cursor": "string"}
POST
/v1/clusters/{cluster_id}/secrets

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

The value is write-only: it is never returned.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid

Request Body

Create a secret. The value is stored encrypted and never returned.

application/json
  1. body

Create a secret. The value is stored encrypted and never returned.

description?|

Free text.

injection_mode?|

env (default), file or both.

mount_path?|

Where to mount a file/both secret.

name*string

The name, unique within the cluster or environment.

secret_type?|

opaque (default), database, registry or tls.

value*string

The value (write-only).

write_only?boolean

Make the key write-only: nobody can read its value back, in the console or the API (apps still receive it). One-way.

Defaultfalse

Response Body

The created secret

application/json
  1. response

A secret's metadata, as the public API shows it. The value is never part of it.

created_at*string

When the secret was created (RFC 3339, UTC).

Formatdate-time
description?|

Free text.

expires_at?|

When the value expires (RFC 3339, UTC).

Formatdate-time
has_value*boolean

False for a secret declared without a value (in IaC) until one is set; apps do not receive it until then.

id*string

The secret id.

Formatuuid
injection_mode*string

How apps receive it: env, file or both.

keep_versions?|

How many replaced versions the secret keeps (1 to 100, each billed like the current value); null = the default, 10. Older ones are destroyed.

Formatint32
mount_path?|

Where a file secret is mounted.

name*string

The name, unique within its scope (the environment variable name for env injection).

rotated_at?|

When the value was last rotated (RFC 3339, UTC).

Formatdate-time
scope_id*string

The id of that cluster, environment, project or app.

Formatuuid
scope_type*string

What the secret belongs to: cluster, environment, project or app.

secret_type*string

opaque, database, registry or tls (new values may be added).

updated_at*string

When the secret last changed (RFC 3339, UTC).

Formatdate-time
value_origin*string

Who set the value: user, generated or app_credential.

version*integer

The current version; every value change adds one.

Formatint32
write_only*boolean

The value can be replaced or deleted but never read back by anyone (apps still receive it). One-way.

Example Request
curl -X POST 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/secrets' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"name":"example","value":"example"}'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "expires_at": "2019-08-24T14:15:22Z",  "has_value": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "injection_mode": "string",  "keep_versions": 0,  "mount_path": "string",  "name": "string",  "rotated_at": "2019-08-24T14:15:22Z",  "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",  "scope_type": "string",  "secret_type": "string",  "updated_at": "2019-08-24T14:15:22Z",  "value_origin": "string",  "version": 0,  "write_only": true}
GET
/v1/clusters/{cluster_id}/secrets/{secret_id}

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Get a cluster secret's metadata (never its value).

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
secret_id*string

The secret UUID

Formatuuid

Response Body

The secret

application/json
  1. response

A secret's metadata, as the public API shows it. The value is never part of it.

created_at*string

When the secret was created (RFC 3339, UTC).

Formatdate-time
description?|

Free text.

expires_at?|

When the value expires (RFC 3339, UTC).

Formatdate-time
has_value*boolean

False for a secret declared without a value (in IaC) until one is set; apps do not receive it until then.

id*string

The secret id.

Formatuuid
injection_mode*string

How apps receive it: env, file or both.

keep_versions?|

How many replaced versions the secret keeps (1 to 100, each billed like the current value); null = the default, 10. Older ones are destroyed.

Formatint32
mount_path?|

Where a file secret is mounted.

name*string

The name, unique within its scope (the environment variable name for env injection).

rotated_at?|

When the value was last rotated (RFC 3339, UTC).

Formatdate-time
scope_id*string

The id of that cluster, environment, project or app.

Formatuuid
scope_type*string

What the secret belongs to: cluster, environment, project or app.

secret_type*string

opaque, database, registry or tls (new values may be added).

updated_at*string

When the secret last changed (RFC 3339, UTC).

Formatdate-time
value_origin*string

Who set the value: user, generated or app_credential.

version*integer

The current version; every value change adds one.

Formatint32
write_only*boolean

The value can be replaced or deleted but never read back by anyone (apps still receive it). One-way.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/secrets/00000000-0000-4000-8000-000000000002' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "expires_at": "2019-08-24T14:15:22Z",  "has_value": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "injection_mode": "string",  "keep_versions": 0,  "mount_path": "string",  "name": "string",  "rotated_at": "2019-08-24T14:15:22Z",  "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",  "scope_type": "string",  "secret_type": "string",  "updated_at": "2019-08-24T14:15:22Z",  "value_origin": "string",  "version": 0,  "write_only": true}
DELETE
/v1/clusters/{cluster_id}/secrets/{secret_id}

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
secret_id*string

The secret UUID

Formatuuid

Response Body

Deleted

Example Request
curl -X DELETE 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/secrets/00000000-0000-4000-8000-000000000002' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
Empty
PUT
/v1/clusters/{cluster_id}/secrets/{secret_id}/value

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Set a cluster secret's value: it becomes the next version. The value is write-only: it is never returned.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
secret_id*string

The secret UUID

Formatuuid

Request Body

A new value for a secret (write-only). It becomes the next version.

application/json
  1. body

A new value for a secret (write-only). It becomes the next version.

value*string

The new value.

Response Body

The secret with its new version

application/json
  1. response

A secret's metadata, as the public API shows it. The value is never part of it.

created_at*string

When the secret was created (RFC 3339, UTC).

Formatdate-time
description?|

Free text.

expires_at?|

When the value expires (RFC 3339, UTC).

Formatdate-time
has_value*boolean

False for a secret declared without a value (in IaC) until one is set; apps do not receive it until then.

id*string

The secret id.

Formatuuid
injection_mode*string

How apps receive it: env, file or both.

keep_versions?|

How many replaced versions the secret keeps (1 to 100, each billed like the current value); null = the default, 10. Older ones are destroyed.

Formatint32
mount_path?|

Where a file secret is mounted.

name*string

The name, unique within its scope (the environment variable name for env injection).

rotated_at?|

When the value was last rotated (RFC 3339, UTC).

Formatdate-time
scope_id*string

The id of that cluster, environment, project or app.

Formatuuid
scope_type*string

What the secret belongs to: cluster, environment, project or app.

secret_type*string

opaque, database, registry or tls (new values may be added).

updated_at*string

When the secret last changed (RFC 3339, UTC).

Formatdate-time
value_origin*string

Who set the value: user, generated or app_credential.

version*integer

The current version; every value change adds one.

Formatint32
write_only*boolean

The value can be replaced or deleted but never read back by anyone (apps still receive it). One-way.

Example Request
curl -X PUT 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/secrets/00000000-0000-4000-8000-000000000002/value' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"value":"example"}'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "expires_at": "2019-08-24T14:15:22Z",  "has_value": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "injection_mode": "string",  "keep_versions": 0,  "mount_path": "string",  "name": "string",  "rotated_at": "2019-08-24T14:15:22Z",  "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",  "scope_type": "string",  "secret_type": "string",  "updated_at": "2019-08-24T14:15:22Z",  "value_origin": "string",  "version": 0,  "write_only": true}
GET
/v1/environments/{environment_id}/secret-groups

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Ordered by creation time, oldest first. Cursor paginated.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

environment_id*string

The environment UUID

Formatuuid

Query Parameters

cursor?|

Opaque cursor from the previous page's next_cursor.

limit?|

Page size, 1 to 100 (default 25).

Formatuint
Range0 <= value

Response Body

A page of secret groups

application/json
  1. response

One page of a v1 list.

data*array<>

The items, in the documented order.

has_more*boolean

Whether more items follow this page.

next_cursor?|

Pass as cursor to get the next page; null on the last page.

Example Request
curl 'https://api.a-line.cloud/v1/environments/00000000-0000-4000-8000-000000000001/secret-groups' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "description": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "member_count": 0,      "name": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "has_more": true,  "next_cursor": "string"}
POST
/v1/environments/{environment_id}/secret-groups

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

environment_id*string

The environment UUID

Formatuuid

Request Body

A new secret group (empty; add members afterwards).

application/json
  1. body

A new secret group (empty; add members afterwards).

description?|

Free text.

name*string

The name, unique within the environment.

Response Body

The created group

application/json
  1. response

A secret group, as the public API shows it.

created_at*string

When the group was created (RFC 3339, UTC).

Formatdate-time
description?|

Free text.

id*string

The group id.

Formatuuid
member_count*integer

How many secrets the group holds.

Formatint64
name*string

The name, unique within the environment.

updated_at*string

When the group last changed (RFC 3339, UTC).

Formatdate-time
Example Request
curl -X POST 'https://api.a-line.cloud/v1/environments/00000000-0000-4000-8000-000000000001/secret-groups' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"name":"example"}'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "member_count": 0,  "name": "string",  "updated_at": "2019-08-24T14:15:22Z"}
GET
/v1/environments/{environment_id}/secret-groups/{group_id}

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Get a secret group with its member secrets (metadata only, never values).

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

environment_id*string

The environment UUID

Formatuuid
group_id*string

The secret group UUID

Formatuuid

Response Body

The group and its members

application/json
  1. response

A secret group with its members.

created_at*string

When the group was created (RFC 3339, UTC).

Formatdate-time
description?|

Free text.

id*string

The group id.

Formatuuid
keys_without_value*array<string>

Member keys without a value yet.

managed_in_git?|

The infra link file describing the group, null when it is not managed in git.

members*array<>

The secrets in the group.

name*string

The name, unique within the environment.

updated_at*string

When the group last changed (RFC 3339, UTC).

Formatdate-time
Example Request
curl 'https://api.a-line.cloud/v1/environments/00000000-0000-4000-8000-000000000001/secret-groups/00000000-0000-4000-8000-000000000002' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "keys_without_value": [    "string"  ],  "managed_in_git": {    "branch": "string",    "file": "string"  },  "members": [    {      "has_value": true,      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "injection_mode": "string",      "mount_path": "string",      "name": "string",      "secret_type": "string"    }  ],  "name": "string",  "updated_at": "2019-08-24T14:15:22Z"}
POST
/v1/environments/{environment_id}/secret-groups/{group_id}/members

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Secrets already in the group are skipped, so the call is safe to repeat.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

environment_id*string

The environment UUID

Formatuuid
group_id*string

The secret group UUID

Formatuuid

Request Body

Secrets to add to a group. Secrets already in it are skipped.

application/json
  1. body

Secrets to add to a group. Secrets already in it are skipped.

secret_ids*array<>

Ids of secrets this environment may inject (its own or its clusters').

Response Body

How many secrets were added

application/json
  1. response

How many of the given secrets were not in the group yet.

added*integer

Secrets added by this request (0 when all were members already).

Formatint64
Example Request
curl -X POST 'https://api.a-line.cloud/v1/environments/00000000-0000-4000-8000-000000000001/secret-groups/00000000-0000-4000-8000-000000000002/members' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"secret_ids":[]}'
Example Response
{  "added": 0}
GET
/v1/environments/{environment_id}/secrets

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

List an environment's secrets and those of its clusters (metadata only, never values).

Ordered by creation time, oldest first. Cursor paginated.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

environment_id*string

The environment UUID

Formatuuid

Query Parameters

cursor?|

Opaque cursor from the previous page's next_cursor.

limit?|

Page size, 1 to 100 (default 25).

Formatuint
Range0 <= value

Response Body

A page of secrets

application/json
  1. response

One page of a v1 list.

data*array<>

The items, in the documented order.

has_more*boolean

Whether more items follow this page.

next_cursor?|

Pass as cursor to get the next page; null on the last page.

Example Request
curl 'https://api.a-line.cloud/v1/environments/00000000-0000-4000-8000-000000000001/secrets' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "description": "string",      "expires_at": "2019-08-24T14:15:22Z",      "has_value": true,      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "injection_mode": "string",      "keep_versions": 0,      "mount_path": "string",      "name": "string",      "rotated_at": "2019-08-24T14:15:22Z",      "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",      "scope_type": "string",      "secret_type": "string",      "updated_at": "2019-08-24T14:15:22Z",      "value_origin": "string",      "version": 0,      "write_only": true    }  ],  "has_more": true,  "next_cursor": "string"}
POST
/v1/environments/{environment_id}/secrets

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

The value is write-only: it is never returned.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

environment_id*string

The environment UUID

Formatuuid

Request Body

Create a secret. The value is stored encrypted and never returned.

application/json
  1. body

Create a secret. The value is stored encrypted and never returned.

description?|

Free text.

injection_mode?|

env (default), file or both.

mount_path?|

Where to mount a file/both secret.

name*string

The name, unique within the cluster or environment.

secret_type?|

opaque (default), database, registry or tls.

value*string

The value (write-only).

write_only?boolean

Make the key write-only: nobody can read its value back, in the console or the API (apps still receive it). One-way.

Defaultfalse

Response Body

The created secret

application/json
  1. response

A secret's metadata, as the public API shows it. The value is never part of it.

created_at*string

When the secret was created (RFC 3339, UTC).

Formatdate-time
description?|

Free text.

expires_at?|

When the value expires (RFC 3339, UTC).

Formatdate-time
has_value*boolean

False for a secret declared without a value (in IaC) until one is set; apps do not receive it until then.

id*string

The secret id.

Formatuuid
injection_mode*string

How apps receive it: env, file or both.

keep_versions?|

How many replaced versions the secret keeps (1 to 100, each billed like the current value); null = the default, 10. Older ones are destroyed.

Formatint32
mount_path?|

Where a file secret is mounted.

name*string

The name, unique within its scope (the environment variable name for env injection).

rotated_at?|

When the value was last rotated (RFC 3339, UTC).

Formatdate-time
scope_id*string

The id of that cluster, environment, project or app.

Formatuuid
scope_type*string

What the secret belongs to: cluster, environment, project or app.

secret_type*string

opaque, database, registry or tls (new values may be added).

updated_at*string

When the secret last changed (RFC 3339, UTC).

Formatdate-time
value_origin*string

Who set the value: user, generated or app_credential.

version*integer

The current version; every value change adds one.

Formatint32
write_only*boolean

The value can be replaced or deleted but never read back by anyone (apps still receive it). One-way.

Example Request
curl -X POST 'https://api.a-line.cloud/v1/environments/00000000-0000-4000-8000-000000000001/secrets' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"name":"example","value":"example"}'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "expires_at": "2019-08-24T14:15:22Z",  "has_value": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "injection_mode": "string",  "keep_versions": 0,  "mount_path": "string",  "name": "string",  "rotated_at": "2019-08-24T14:15:22Z",  "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",  "scope_type": "string",  "secret_type": "string",  "updated_at": "2019-08-24T14:15:22Z",  "value_origin": "string",  "version": 0,  "write_only": true}
GET
/v1/environments/{environment_id}/secrets/{secret_id}

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Get the metadata of an environment secret or one of its clusters' secrets (never its value).

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

environment_id*string

The environment UUID

Formatuuid
secret_id*string

The secret UUID

Formatuuid

Response Body

The secret

application/json
  1. response

A secret's metadata, as the public API shows it. The value is never part of it.

created_at*string

When the secret was created (RFC 3339, UTC).

Formatdate-time
description?|

Free text.

expires_at?|

When the value expires (RFC 3339, UTC).

Formatdate-time
has_value*boolean

False for a secret declared without a value (in IaC) until one is set; apps do not receive it until then.

id*string

The secret id.

Formatuuid
injection_mode*string

How apps receive it: env, file or both.

keep_versions?|

How many replaced versions the secret keeps (1 to 100, each billed like the current value); null = the default, 10. Older ones are destroyed.

Formatint32
mount_path?|

Where a file secret is mounted.

name*string

The name, unique within its scope (the environment variable name for env injection).

rotated_at?|

When the value was last rotated (RFC 3339, UTC).

Formatdate-time
scope_id*string

The id of that cluster, environment, project or app.

Formatuuid
scope_type*string

What the secret belongs to: cluster, environment, project or app.

secret_type*string

opaque, database, registry or tls (new values may be added).

updated_at*string

When the secret last changed (RFC 3339, UTC).

Formatdate-time
value_origin*string

Who set the value: user, generated or app_credential.

version*integer

The current version; every value change adds one.

Formatint32
write_only*boolean

The value can be replaced or deleted but never read back by anyone (apps still receive it). One-way.

Example Request
curl 'https://api.a-line.cloud/v1/environments/00000000-0000-4000-8000-000000000001/secrets/00000000-0000-4000-8000-000000000002' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "expires_at": "2019-08-24T14:15:22Z",  "has_value": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "injection_mode": "string",  "keep_versions": 0,  "mount_path": "string",  "name": "string",  "rotated_at": "2019-08-24T14:15:22Z",  "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",  "scope_type": "string",  "secret_type": "string",  "updated_at": "2019-08-24T14:15:22Z",  "value_origin": "string",  "version": 0,  "write_only": true}
DELETE
/v1/environments/{environment_id}/secrets/{secret_id}

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

environment_id*string

The environment UUID

Formatuuid
secret_id*string

The secret UUID

Formatuuid

Response Body

Deleted

Example Request
curl -X DELETE 'https://api.a-line.cloud/v1/environments/00000000-0000-4000-8000-000000000001/secrets/00000000-0000-4000-8000-000000000002' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
Empty
PUT
/v1/environments/{environment_id}/secrets/{secret_id}/value

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Set an environment secret's value: it becomes the next version. The value is write-only: it is never returned.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

environment_id*string

The environment UUID

Formatuuid
secret_id*string

The secret UUID

Formatuuid

Request Body

A new value for a secret (write-only). It becomes the next version.

application/json
  1. body

A new value for a secret (write-only). It becomes the next version.

value*string

The new value.

Response Body

The secret with its new version

application/json
  1. response

A secret's metadata, as the public API shows it. The value is never part of it.

created_at*string

When the secret was created (RFC 3339, UTC).

Formatdate-time
description?|

Free text.

expires_at?|

When the value expires (RFC 3339, UTC).

Formatdate-time
has_value*boolean

False for a secret declared without a value (in IaC) until one is set; apps do not receive it until then.

id*string

The secret id.

Formatuuid
injection_mode*string

How apps receive it: env, file or both.

keep_versions?|

How many replaced versions the secret keeps (1 to 100, each billed like the current value); null = the default, 10. Older ones are destroyed.

Formatint32
mount_path?|

Where a file secret is mounted.

name*string

The name, unique within its scope (the environment variable name for env injection).

rotated_at?|

When the value was last rotated (RFC 3339, UTC).

Formatdate-time
scope_id*string

The id of that cluster, environment, project or app.

Formatuuid
scope_type*string

What the secret belongs to: cluster, environment, project or app.

secret_type*string

opaque, database, registry or tls (new values may be added).

updated_at*string

When the secret last changed (RFC 3339, UTC).

Formatdate-time
value_origin*string

Who set the value: user, generated or app_credential.

version*integer

The current version; every value change adds one.

Formatint32
write_only*boolean

The value can be replaced or deleted but never read back by anyone (apps still receive it). One-way.

Example Request
curl -X PUT 'https://api.a-line.cloud/v1/environments/00000000-0000-4000-8000-000000000001/secrets/00000000-0000-4000-8000-000000000002/value' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"value":"example"}'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "expires_at": "2019-08-24T14:15:22Z",  "has_value": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "injection_mode": "string",  "keep_versions": 0,  "mount_path": "string",  "name": "string",  "rotated_at": "2019-08-24T14:15:22Z",  "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",  "scope_type": "string",  "secret_type": "string",  "updated_at": "2019-08-24T14:15:22Z",  "value_origin": "string",  "version": 0,  "write_only": true}

On this page