For the complete documentation index, see llms.txt. This page is also available as Markdown.

Credentials

Add Tag

post
Path parameters
uidintegerRequired
Body
namestringRequiredPattern: ^[^:]+$
valuestringRequiredPattern: ^[^:]+$
colorstring · nullableOptional
Responses
201

Successful Response

application/json
anyOptional
post/api/v2/credentials/{uid}/tags
POST /api/v2/credentials/{uid}/tags HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "value": "text",
  "color": "text"
}

No content

Update Tag

put
Path parameters
uidintegerRequired
tag_idintegerRequired
Body
namestringRequiredPattern: ^[^:]+$
valuestringRequiredPattern: ^[^:]+$
colorstring · nullableOptional
Responses
200

Successful Response

application/json
anyOptional
put/api/v2/credentials/{uid}/tags/{tag_id}
PUT /api/v2/credentials/{uid}/tags/{tag_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "value": "text",
  "color": "text"
}

No content

Delete Tag

delete
Path parameters
uidintegerRequired
tag_idintegerRequired
Responses
204

Successful Response

No content

delete/api/v2/credentials/{uid}/tags/{tag_id}
DELETE /api/v2/credentials/{uid}/tags/{tag_id} HTTP/1.1
Accept: */*

No content

Read Credential

get
Path parameters
uidintegerRequired
Responses
200

Successful Response

application/json
idintegerRequired
credtypestringRequired
domainstringRequired
usernamestringRequired
passwordstringRequired
hoststringRequired
osstring · nullableOptional
sidstring · nullableOptional
notesstring · nullableOptional
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
get/api/v2/credentials/{uid}
GET /api/v2/credentials/{uid} HTTP/1.1
Accept: */*
{
  "id": 1,
  "credtype": "text",
  "domain": "text",
  "username": "text",
  "password": "text",
  "host": "text",
  "os": "text",
  "sid": "text",
  "notes": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Update Credential

put
Path parameters
uidintegerRequired
Body
credtypestringRequired
domainstringRequired
usernamestringRequired
passwordstringRequired
hoststringRequired
osstring · nullableOptional
sidstring · nullableOptional
notesstring · nullableOptional
Responses
200

Successful Response

application/json
idintegerRequired
credtypestringRequired
domainstringRequired
usernamestringRequired
passwordstringRequired
hoststringRequired
osstring · nullableOptional
sidstring · nullableOptional
notesstring · nullableOptional
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
put/api/v2/credentials/{uid}
PUT /api/v2/credentials/{uid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "credtype": "text",
  "domain": "text",
  "username": "text",
  "password": "text",
  "host": "text",
  "os": "text",
  "sid": "text",
  "notes": "text"
}
{
  "id": 1,
  "credtype": "text",
  "domain": "text",
  "username": "text",
  "password": "text",
  "host": "text",
  "os": "text",
  "sid": "text",
  "notes": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Delete Credential

delete
Path parameters
uidintegerRequired
Responses
204

Successful Response

No content

delete/api/v2/credentials/{uid}
DELETE /api/v2/credentials/{uid} HTTP/1.1
Accept: */*

No content

Read Credentials

get
Query parameters
searchstring · nullableOptional
credtypestring · nullableOptional
tagsstring[] · nullableOptional
Responses
200

Successful Response

application/json
get/api/v2/credentials
GET /api/v2/credentials HTTP/1.1
Accept: */*
{
  "records": [
    {
      "id": 1,
      "credtype": "text",
      "domain": "text",
      "username": "text",
      "password": "text",
      "host": "text",
      "os": "text",
      "sid": "text",
      "notes": "text",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z",
      "tags": [
        {
          "id": 1,
          "name": "text",
          "value": "text",
          "label": "text",
          "color": "text"
        }
      ]
    }
  ]
}

Create Credential

post
Body
credtypestringRequired
domainstringRequired
usernamestringRequired
passwordstringRequired
hoststringRequired
osstring · nullableOptional
sidstring · nullableOptional
notesstring · nullableOptional
Responses
201

Successful Response

application/json
idintegerRequired
credtypestringRequired
domainstringRequired
usernamestringRequired
passwordstringRequired
hoststringRequired
osstring · nullableOptional
sidstring · nullableOptional
notesstring · nullableOptional
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
post/api/v2/credentials
POST /api/v2/credentials HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "credtype": "text",
  "domain": "text",
  "username": "text",
  "password": "text",
  "host": "text",
  "os": "text",
  "sid": "text",
  "notes": "text"
}
{
  "id": 1,
  "credtype": "text",
  "domain": "text",
  "username": "text",
  "password": "text",
  "host": "text",
  "os": "text",
  "sid": "text",
  "notes": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Last updated

Was this helpful?