Skip to content

Generate Client Config Endpoint

POST
/user/generate-client-config
 
curl --request POST \
  --url https://example.com/user/generate-client-config \
  --header 'Content-Type: application/json' \
  --header 'X-Tenzir-UserKey: <X-Tenzir-UserKey>' \
  --data '{ "config_type": "tenzir", "tenant_id": "example", "node_name": "example", "node_id": "example" }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
GenerateClientConfigRequest
object
config_type
required
ConfigType
string
Allowed values: tenzir docker tenzir-node
tenant_id
required
Tenant Id
string
node_name
Any of:
string
node_id
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
GenerateClientConfigResponse
object
filename
required
Filename
string
contents
required
Contents
string
node_id
required
Node Id
string
Example generated
{
  "filename": "example",
  "contents": "example",
  "node_id": "example"
}

403

Section titled “403 ”

{"detail": "Invalid API Key"} {"detail": "Not permitted to access this tenant"}

404

Section titled “404 ”

{"detail": "Tenant not found"}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}