Change a named token. A token may change its own description and autolink default; permissions are the owner's.

POST

/datanotes/tokens/update/

curl --request POST \
  --url https://example.com/datanotes/tokens/update/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Datanotes-Actor: {"harness":"my-script","model":"","session":"s-1"}' \
  --data '{ "name": "example", "description": "example", "write": [ "example" ], "ddl": true, "maintain": true, "autolink": true }'

Authorizations

• bearer

Parameters

Header Parameters

X-Datanotes-Actor

string

JSON: on whose behalf the write is made, recorded in the journal (harness, model, session).

Example

{"harness":"my-script","model":"","session":"s-1"}

Request Body

Media typeapplication/json

object

name

Owner only (a named token updates itself).

string

description

An empty string removes it.

string

write

Array<string>

ddl

boolean

maintain

boolean

autolink

The default of the token’s writes for automatic links; null follows the database’s setting again.

boolean | null

Example ^generated

{
  "name": "example",
  "description": "example",
  "write": [
    "example"
  ],
  "ddl": true,
  "maintain": true,
  "autolink": true
}

Responses

200

Done.

Media typeapplication/json

object

entry

A named token as the registry shows it (never its value).

object

name

required

string

description

string

write

required

Array<string>

ddl

required

boolean

maintain

boolean

autolink

The default of its writes for automatic links (absent: the database’s setting).

boolean

created_at

required

string

updated_at

required

string

last_seen

The last request made with it (saved within a minute).

string

Example ^generated

{
  "entry": {
    "name": "example",
    "description": "example",
    "write": [
      "example"
    ],
    "ddl": true,
    "maintain": true,
    "autolink": true,
    "created_at": "example",
    "updated_at": "example",
    "last_seen": "example"
  }
}

400

Bad input: the body is not a JSON object, or an argument is unknown, missing or of the wrong type.

Media typeapplication/json

object

error

required

What went wrong, for a person or an agent.

string

Example ^generated

{
  "error": "example"
}

401

Missing or wrong bearer token.

Media typeapplication/json

object

error

required

What went wrong, for a person or an agent.

string

Example ^generated

{
  "error": "example"
}

403

A named token beyond its permissions (the engine’s administration, tables outside its write patterns, schema changes without ddl).

Media typeapplication/json

object

error

required

What went wrong, for a person or an agent.

string

Example ^generated

{
  "error": "example"
}

500

Unexpected error.

Media typeapplication/json

object

error

required

What went wrong, for a person or an agent.

string

Example ^generated

{
  "error": "example"
}