Skip to content
Authrim

Create or update a runtime profile.

PUT
/api/admin/runtime-profiles/{kind}/{id}
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/runtime-profiles/audit/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "label": "D1 audit log", "description": "Persist audit events in the configured audit D1 binding.", "primary": { "type": "d1", "bindingRef": "DB_AUDIT", "dataset": "event_log" }, "archive": null, "sinks": [] }'

Create or replace an audit or residency profile in the configured registry backend. Built-in profiles are read-only.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
kind
required
string
Allowed values: audit residency
id
required
string

Header Parameters

Section titled “Header Parameters ”
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Request Body required

Section titled “Request Body required ”
Media type application/json

Kind-specific runtime profile body. The handler validates the body according to the runtime profile kind in the path.

object
key
additional properties
Example 
{
  "label": "D1 audit log",
  "description": "Persist audit events in the configured audit D1 binding.",
  "primary": {
    "type": "d1",
    "bindingRef": "DB_AUDIT",
    "dataset": "event_log"
  },
  "archive": null,
  "sinks": []
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Runtime profile create or update response.

Media type application/json
object
registry_backend
required
string
created
required
boolean
profile
required
object
id
required
string
kind
string
Allowed values: audit residency
displayName
string
description
string
source
string
key
additional properties
reference_status
required
Array<object>
object
key
additional properties
activation_status
required
object
state
required
string
activatable
required
boolean
severity
required
string
Allowed values: info warning error
blockingReasons
required
Array<string>
warnings
required
Array<string>
key
additional properties
reference_catalog
required
object
key
additional properties
reference_management
required
object
key
additional properties
key
additional properties
Example 
{
  "profile": {
    "kind": "audit"
  },
  "activation_status": {
    "severity": "info"
  }
}

201

Section titled “201 ”

Runtime profile create or update response.

Media type application/json
object
registry_backend
required
string
created
required
boolean
profile
required
object
id
required
string
kind
string
Allowed values: audit residency
displayName
string
description
string
source
string
key
additional properties
reference_status
required
Array<object>
object
key
additional properties
activation_status
required
object
state
required
string
activatable
required
boolean
severity
required
string
Allowed values: info warning error
blockingReasons
required
Array<string>
warnings
required
Array<string>
key
additional properties
reference_catalog
required
object
key
additional properties
reference_management
required
object
key
additional properties
key
additional properties
Example 
{
  "profile": {
    "kind": "audit"
  },
  "activation_status": {
    "severity": "info"
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}