API docs by Redocly

Obsyk Platform API (1.0)

Download OpenAPI specification:

Obsyk Support: [email protected] URL: https://obsyk.ai/support License: Proprietary Terms of Service

REST API for Obsyk - Observability & Security for AI Workloads

Clusters

Cluster management endpoints

List clusters

Returns all clusters for the authenticated user's organization

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Register a new cluster

Creates a new cluster and returns OAuth client credentials for agent authentication

Authorizations:
BearerAuth
Request Body schema: application/json
required

Cluster registration request

name
required
string [ 1 .. 253 ] characters
publicKey
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "publicKey": "string"
}

Response samples

Content type
application/json
{
  • "clientId": "string",
  • "createdAt": "string",
  • "id": "string",
  • "name": "string",
  • "status": "string"
}

Delete a cluster

Removes a cluster and its associated OAuth client and resources

Authorizations:
BearerAuth
path Parameters
id
required
string

Cluster ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get cluster details

Returns detailed information for a specific cluster

Authorizations:
BearerAuth
path Parameters
id
required
string

Cluster ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "agentVersion": "string",
  • "clusterUid": "string",
  • "createdAt": "string",
  • "id": "string",
  • "kubernetesVersion": "string",
  • "lastHeartbeatAt": "string",
  • "lastSnapshotAt": "string",
  • "name": "string",
  • "namespaceCount": 0,
  • "platform": "string",
  • "podCount": 0,
  • "region": "string",
  • "serviceCount": 0,
  • "status": "string"
}

Get cluster resources

Returns namespaces and resource counts for a specific cluster

Authorizations:
BearerAuth
path Parameters
id
required
string

Cluster ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "namespaces": [
    ],
  • "podCount": 0,
  • "serviceCount": 0
}

List daemonsets in a namespace

Returns all daemonsets for a specific namespace in a cluster

Authorizations:
BearerAuth
path Parameters
id
required
string

Cluster ID (UUID)

namespace
required
string

Namespace name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List deployments in a namespace

Returns all deployments for a specific namespace in a cluster

Authorizations:
BearerAuth
path Parameters
id
required
string

Cluster ID (UUID)

namespace
required
string

Namespace name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List statefulsets in a namespace

Returns all statefulsets for a specific namespace in a cluster

Authorizations:
BearerAuth
path Parameters
id
required
string

Cluster ID (UUID)

namespace
required
string

Namespace name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Users

User management endpoints

List users

Returns all users in the authenticated user's organization

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remove user

Removes a user from the organization (does not delete the user account)

Authorizations:
BearerAuth
path Parameters
id
required
string

User ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Update user role

Updates a user's role in the organization

Authorizations:
BearerAuth
path Parameters
id
required
string

User ID (UUID)

Request Body schema: application/json
required

Role update request

role
required
string

Responses

Request samples

Content type
application/json
{
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Invite user

Invites a new user to the organization or adds an existing user

Authorizations:
BearerAuth
Request Body schema: application/json
required

Invite request

email
required
string
name
string
role
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Auth

Authentication endpoints

Agent

Agent API for Obsyk Operator (OAuth2 JWT Bearer)