updateSecret

PATCH

/api/v1/secrets/{secretId}

updateSecret

curl --request PATCH \
  --url '<base-url>/api/v1/secrets/<secretId>' \
  --header 'Content-Type: application/json' \
  --cookie 'agenthold_session=<agenthold_session>' \
  --data '
{
  "name": "string",
  "value": "string",
  "rule": {
    "hosts": [
      "string"
    ],
    "header": "string",
    "template": "string"
  }
}
'

const url = '<base-url>/api/v1/secrets/<secretId>';
const options = {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
    cookie: 'agenthold_session=<agenthold_session>'
  },
  body: JSON.stringify({
    name: 'string',
    value: 'string',
    rule: {hosts: ['string'], header: 'string', template: 'string'}
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "<base-url>/api/v1/secrets/<secretId>"

payload = {
    "name": "string",
    "value": "string",
    "rule": {
        "hosts": ["string"],
        "header": "string",
        "template": "string"
    }
}
headers = {
    "cookie": "agenthold_session=<agenthold_session>",
    "Content-Type": "application/json"
}

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

print(response.text)

Response example

{
  "id": "string",
  "workspaceId": "string",
  "name": "string",
  "rule": {
    "hosts": [
      "string"
    ],
    "header": "string",
    "template": "string"
  },
  "placeholder": "string",
  "owner": {
    "id": "string",
    "email": "string",
    "name": "string",
    "avatarUrl": "string"
  },
  "canManage": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

secretId
string
required

Request body JSON required

name
optional
string
maxLength: 100 · minLength: 1
value
optional
string
minLength: 1
rule
optional
object
- hosts
  array of
  string
  required
  Exact host names or "*.example.com".
- header
  string
  required
- template
  string
  required
  Header value; {{.Value}} is the secret. Function: base64.
}

Returns

200

Updated.

JSON

id
string
required
workspaceId
string
required
name
string
required
rule
object
required
- hosts
  array of
  string
  required
  Exact host names or "*.example.com".
- header
  string
  required
- template
  string
  required
  Header value; {{.Value}} is the secret. Function: base64.
}
placeholder
string
required
What sandboxes see instead of the value.
owner
object
required
- id
  string
  required
- email
  string
  required
- name
  string
  required
- avatarUrl
  string
  required
}
canManage
boolean
required
createdAt
string
required
format: date-time
updatedAt
string
required
format: date-time

400

Error.

JSON

error
string
required

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required