Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Systems

Get system

get

Retrieves the details of the specified system by ID.

Path parameters
idintegerRequired

System ID

Responses
200

System details

application/json
get/api/systems/{id}
GET /api/systems/{id} HTTP/1.1
Accept: */*

{
  "data": {
    "deleted_at": null,
    "df_content": {
      "some_key": "some_value"
    },
    "dynamic_content": {
      "some_key": {
        "origin": "user",
        "value": "some_value"
      }
    },
    "external_id": "my_system",
    "id": 1,
    "inserted_at": "2026-06-18T10:00:00Z",
    "name": "My System",
    "updated_at": "2026-06-18T10:00:00Z"
  }
}

Update system

put

Updates the specified system with the provided payload.

Path parameters
idintegerRequired

System ID

Body
Responses
200

System updated

application/json
put/api/systems/{id}
PUT /api/systems/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "system": {
    "df_content": {
      "some_key": "new_value"
    },
    "name": "Updated System Name"
  }
}
{
  "data": {
    "deleted_at": null,
    "df_content": {
      "some_key": "some_value"
    },
    "dynamic_content": {
      "some_key": {
        "origin": "user",
        "value": "some_value"
      }
    },
    "external_id": "my_system",
    "id": 1,
    "inserted_at": "2026-06-18T10:00:00Z",
    "name": "My System",
    "updated_at": "2026-06-18T10:00:00Z"
  }
}

Delete system

delete

Deletes the specified system.

Path parameters
idintegerRequired

System ID

Responses
204

System deleted

No content
delete/api/systems/{id}
DELETE /api/systems/{id} HTTP/1.1
Accept: */*

No content

Update system

patch

Updates the specified system with the provided payload.

Path parameters
idintegerRequired

System ID

Body
Responses
200

System updated

application/json
patch/api/systems/{id}
PATCH /api/systems/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "system": {
    "df_content": {
      "some_key": "new_value"
    },
    "name": "Updated System Name"
  }
}
{
  "data": {
    "deleted_at": null,
    "df_content": {
      "some_key": "some_value"
    },
    "dynamic_content": {
      "some_key": {
        "origin": "user",
        "value": "some_value"
      }
    },
    "external_id": "my_system",
    "id": 1,
    "inserted_at": "2026-06-18T10:00:00Z",
    "name": "My System",
    "updated_at": "2026-06-18T10:00:00Z"
  }
}

Delete a system group

delete

Deletes the specified group from the given system.

Path parameters
system_idstringRequired

System external ID

idstringRequired

Group name

Responses
204

Group deleted

No content
delete/api/systems/{system_id}/groups/{id}
DELETE /api/systems/{system_id}/groups/{id} HTTP/1.1
Accept: */*

No content

List groups for a system

get

Returns groups available within the specified system.

Path parameters
system_idstringRequired

System external ID

Responses
200

Group list response

application/json
datastring[]Required

List of group names for the system

get/api/systems/{system_id}/groups
GET /api/systems/{system_id}/groups HTTP/1.1
Accept: */*

{
  "data": [
    "group1",
    "group2",
    "group3"
  ]
}

List systems

get

Returns systems matching the provided search filters and user permissions.

Responses
200

System list response

application/json
get/api/systems
GET /api/systems HTTP/1.1
Accept: */*

{
  "data": [
    {
      "df_content": {
        "some_key": "some_value"
      },
      "dynamic_content": null,
      "external_id": "my_system",
      "id": 1,
      "inserted_at": "2026-06-18T10:00:00Z",
      "name": "My System",
      "structures_count": {
        "count": 10,
        "types": [
          {
            "count": 8,
            "name": "table"
          }
        ]
      },
      "updated_at": "2026-06-18T10:00:00Z"
    }
  ]
}

Create system

post

Creates a new system with the provided data.

Body
Responses
201

System created

application/json
post/api/systems
POST /api/systems HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "system": {
    "df_content": {
      "some_key": "some_value"
    },
    "external_id": "my_system",
    "name": "My System"
  }
}
{
  "data": {
    "deleted_at": null,
    "df_content": {
      "some_key": "some_value"
    },
    "dynamic_content": {
      "some_key": {
        "origin": "user",
        "value": "some_value"
      }
    },
    "external_id": "my_system",
    "id": 1,
    "inserted_at": "2026-06-18T10:00:00Z",
    "name": "My System",
    "updated_at": "2026-06-18T10:00:00Z"
  }
}

Create or upload metadata for a system

post

Uploads or creates metadata for the specified system.

Path parameters
system_idstringRequired

System external ID

Body
data_fieldsstring · binary · nullableOptional

CSV file with field metadata

data_structure_relationsany of · nullableOptional
string · binaryOptional

CSV file with structure relations

or
data_structuresany ofRequired

Structure metadata (file or JSON object)

string · binaryOptional

CSV file with structure metadata

or
domainstring · nullableOptional

Domain external ID

inherit_domainsstring · nullableOptional

Inherit domains (true/false)

job_idstring · nullableOptional

Job ID for tracking

sourcestring · nullableOptional

Source external ID

Responses
202

Metadata accepted

No content
post/api/systems/{system_id}/metadata
POST /api/systems/{system_id}/metadata HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "data_fields": "@data_fields.csv",
  "data_structure_relations": "@data_structure_relations.csv",
  "data_structures": "@data_structures.csv"
}
No content

Update metadata for a system

put

Updates metadata for the specified system using the provided payload.

Path parameters
system_idstringRequired

System external ID

Body
opstringRequired

Operation type (e.g., 'merge', 'replace')

Responses
202

Metadata update accepted

No content
put/api/systems/{system_id}/metadata
PUT /api/systems/{system_id}/metadata HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "op": "merge",
  "values": [
    {
      "external_id": "id1",
      "name": "New name"
    }
  ]
}
No content

Update metadata for a system

patch

Updates metadata for the specified system using the provided payload.

Path parameters
system_idstringRequired

System external ID

Body
opstringRequired

Operation type (e.g., 'merge', 'replace')

Responses
202

Metadata update accepted

No content
patch/api/systems/{system_id}/metadata
PATCH /api/systems/{system_id}/metadata HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "op": "merge",
  "values": [
    {
      "external_id": "id1",
      "name": "New name"
    }
  ]
}
No content

Last updated