Adopt a Secret key into a secret slot

import requests

url = "https://platform.ankra.app/api/v1/org/secret-slots/adopt"

payload = {
    "label": "<string>",
    "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "namespace": "<string>",
    "name": "<string>",
    "key": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    cluster_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    namespace: '<string>',
    name: '<string>',
    key: '<string>'
  })
};

fetch('https://platform.ankra.app/api/v1/org/secret-slots/adopt', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/org/secret-slots/adopt \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "namespace": "<string>",
  "name": "<string>",
  "key": "<string>"
}
'

{
  "slot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "hint": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "last_accessed_at": "2023-11-07T05:31:56Z",
  "access_count": 123,
  "sentinel": "<string>",
  "created_via": "user",
  "pinned_at": "2023-11-07T05:31:56Z",
  "references": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>",
      "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource_kind": "<string>",
      "resource_name": "<string>",
      "document_path": "<string>",
      "last_seen_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_by_user_id": "<string>"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "permission_denied",
  "permission": "<string>",
  "scope_type": "<string>"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Cluster not found"
}

Secret Slots

Adopt a Secret key into a secret slot

Reads one key of a Kubernetes Secret live from its cluster and stores it in a new secret slot, without the value leaving Ankra: the value is never returned, and the Secret’s other keys are never read out. Needs kubernetes.secrets_reveal on the cluster as well as variables.write, and is recorded in the audit log as a reveal of that one key. The value is stored byte for byte; set strip_trailing_line_ending to drop one trailing line ending.

POST

api

org

secret-slots

adopt

Adopt a Secret key into a secret slot

import requests

url = "https://platform.ankra.app/api/v1/org/secret-slots/adopt"

payload = {
    "label": "<string>",
    "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "namespace": "<string>",
    "name": "<string>",
    "key": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    cluster_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    namespace: '<string>',
    name: '<string>',
    key: '<string>'
  })
};

fetch('https://platform.ankra.app/api/v1/org/secret-slots/adopt', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/org/secret-slots/adopt \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "namespace": "<string>",
  "name": "<string>",
  "key": "<string>"
}
'

{
  "slot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "hint": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "last_accessed_at": "2023-11-07T05:31:56Z",
  "access_count": 123,
  "sentinel": "<string>",
  "created_via": "user",
  "pinned_at": "2023-11-07T05:31:56Z",
  "references": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>",
      "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource_kind": "<string>",
      "resource_name": "<string>",
      "document_path": "<string>",
      "last_seen_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_by_user_id": "<string>"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "permission_denied",
  "permission": "<string>",
  "scope_type": "<string>"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Cluster not found"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization

string | null

x-ankra-organisation-id

string | null

Body

application/json

Which key of which Kubernetes Secret to adopt, and the slot to create for it.

label

string

required

The new slot's name, unique in the organisation, with no line breaks.

Required string length: 1 - 120

cluster_id

string<uuid>

required

The cluster the Secret runs in.

namespace

string

required

The Secret's namespace.

Minimum string length: 1

name

string

required

The Secret's name.

Minimum string length: 1

key

string

required

The key under the Secret's data to adopt. No other key is read out.

Minimum string length: 1

hint

string

A note about what the secret is for.

Maximum string length: 240

strip_trailing_line_ending

boolean

default:false

Drop exactly one trailing \n or \r\n from the value before storing it. Leave it off to store the bytes as they are.

Response

The new slot

A secret slot without its value, which is never returned.

slot_id

string<uuid>

required

label

string

required

The slot's name, unique in the organisation.

hint

string | null

required

A note about what the secret is for, or null.

created_at

string<date-time>

required

expires_at

string<date-time> | null

required

When the slot expires, or null when it does not.

last_accessed_at

string<date-time> | null

required

When the value was last read, or null.

access_count

integer

required

How many times the value has been read.

sentinel

string

required

${SECRET_SLOT:<slot_id>}: put this where the value belongs.

created_via

enum<string>

required

user when a person supplied the current value, generated when Ankra created it.

Available options:

user,

generated

pinned_at

string<date-time> | null

required

When the slot was pinned so it does not expire, or null.

references

SecretSlotReference · object[]

required

The live resources that carry the sentinel.

Show child attributes

created_by_user_id

string | null

required

The user who created the slot, or null when unknown.

API reference

Endpoints

Adopt a Secret key into a secret slot

Authorizations

Headers

Body

Response