Credentials

Add Tag

post

Path parameters

uidintegerRequired

Body

application/json

namestringRequiredPattern: ^[^:]+$

valuestringRequiredPattern: ^[^:]+$

colorany ofOptional

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/credentials/{uid}/tags

HTTPcURLJavaScriptPython

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

application/json

namestringRequiredPattern: ^[^:]+$

valuestringRequiredPattern: ^[^:]+$

colorany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put

/api/v2/credentials/{uid}/tags/{tag_id}

HTTPcURLJavaScriptPython

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

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

delete

/api/v2/credentials/{uid}/tags/{tag_id}

HTTPcURLJavaScriptPython

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

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/credentials/{uid}

HTTPcURLJavaScriptPython

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-02-02T15:22:21.207Z",
  "updated_at": "2026-02-02T15:22:21.207Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Update Credential

put

Path parameters

uidintegerRequired

Body

application/json

credtypestringRequired

domainstringRequired

usernamestringRequired

passwordstringRequired

hoststringRequired

osany ofOptional

stringOptional

or

nullOptional

sidany ofOptional

stringOptional

or

nullOptional

notesany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put

/api/v2/credentials/{uid}

HTTPcURLJavaScriptPython

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-02-02T15:22:21.207Z",
  "updated_at": "2026-02-02T15:22:21.207Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Delete Credential

delete

Path parameters

uidintegerRequired

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

delete

/api/v2/credentials/{uid}

HTTPcURLJavaScriptPython

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

No content

Read Credentials

get

Query parameters

searchany ofOptional

stringOptional

or

nullOptional

credtypeany ofOptional

stringOptional

or

nullOptional

tagsany ofOptional

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/credentials

HTTPcURLJavaScriptPython

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-02-02T15:22:21.207Z",
      "updated_at": "2026-02-02T15:22:21.207Z",
      "tags": [
        {
          "id": 1,
          "name": "text",
          "value": "text",
          "label": "text",
          "color": "text"
        }
      ]
    }
  ]
}

Create Credential

post

Body

application/json

credtypestringRequired

domainstringRequired

usernamestringRequired

passwordstringRequired

hoststringRequired

osany ofOptional

stringOptional

or

nullOptional

sidany ofOptional

stringOptional

or

nullOptional

notesany ofOptional

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/credentials

HTTPcURLJavaScriptPython

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-02-02T15:22:21.207Z",
  "updated_at": "2026-02-02T15:22:21.207Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}