Skip to main content
API docs by Redocly

cronkite API definition (1.0.0)

cronkite API definition

/v1/customjob-dashboards

Returns dashboards

Returns dashboards

query Parameters
filter[name]
string <= 255 characters
filter[scope]
string
Enum: "organization" "participant"
individual-group-id
string <uuid>
Example: individual-group-id=11111111-1111-1111-1111-111111111111
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new dashboard

Creates a new dashboard

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-dashboards"
required
object
name
required
string <= 255 characters
required
object or object or object
One of
individual-group-id
string <uuid>
layout-type
string
Default: "custom"
Enum: "custom" "single-column"
scope
string
Default: "organization"
Enum: "organization" "participant"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes an existing dashboard

Deletes an existing dashboard

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific dashboard

Returns specific dashboard

path Parameters
id
required
string

Resource identifier

query Parameters
include-widget-data
boolean
Default: true
scope
string <uuid>
Example: scope=11111111-1111-1111-1111-111111111111
widget-args
object

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing dashboard

Modifies an existing dashboard

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-dashboards"
required
object
null or string
Any of
null
layout-type
string
Enum: "custom" "single-column"
name
string <= 255 characters
scope
string
Enum: "organization" "participant"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-logs

/v1/customjob-logs/{id}/update-result/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
status
required
string <= 16 characters
stderr
required
string <= 99999 characters
stdout
required
string <= 99999 characters
lambda-log
string <= 99999 characters
return
string <= 99999 characters

Responses

Request samples

Content type
application/json
{
  • "lambda-log": "string",
  • "return": "string",
  • "status": "string",
  • "stderr": "string",
  • "stdout": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-reports

/v1/customjob-reports/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/customjob-reports/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-reports"
required
object
name
required
string <= 255 characters
organization-id
required
string <uuid>
source
required
string <= 255 characters
args
object
description
string <= 255 characters
display-name
string <= 255 characters
fields
object
filters
object
sorts
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-reports/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-reports/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-reports/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-reports"
required
object
args
object
description
string <= 255 characters
display-name
string <= 255 characters
fields
object
filters
object
name
string <= 255 characters
sorts
object
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-reports/{id}/download/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/customjob-reports/{id}/prepare-download/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-reports/{id}/preview/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-repositories

Returns repositories

Returns repositories

query Parameters
filter[name]
string <= 255 characters
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new repository

Creates a new repository

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-repositories"
required
object
name
required
string <= 255 characters
organization-id
required
string <uuid>
url
required
string <= 255 characters
private-key
string <= 9999 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes an existing repository

Deletes an existing repository

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific repository

Returns specific repository

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing repository

Modifies an existing repository

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-repositories"
required
object
name
string <= 255 characters
private-key
string <= 9999 characters
url
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-runs

Returns custom-job runs

Returns custom-job runs

query Parameters
filter[status]
string
Enum: "created" "failed" "running" "success"
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
spec-id
string <uuid>
Example: spec-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new job-run

Creates a new job-run

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-runs"
required
object
spec-id
required
string <uuid>
args
object
scope
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes an existing job-run

Deletes an existing job-run

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific job-run

Returns specific job-run

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Retrieve job-run output

Retrieve job-run output

path Parameters
id
required
string

Resource identifier

query Parameters
scope
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/customjob-settings

Returns job settings

Returns job settings

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 64 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new job-spec setting

Creates a new job-spec setting

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-settings"
required
object
name
required
string <= 64 characters
organization-id
required
string <uuid>
value
required
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes an existing job-spec setting

Deletes an existing job-spec setting

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific job setting

Returns specific job setting

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing job-spec setting

Modifies an existing job-spec setting

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-settings"
required
object
value
object
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-sims

/v1/customjob-sims/

Request Body schema: application/json
operation
required
string
Enum: "api" "db-execute"
required
object or object
One of
method
required
string
Enum: "delete" "get" "patch" "post"
path
required
string
json
object
params
object
run-as
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "operation": "api",
  • "params": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-sims/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-sims/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-specs

Returns custom-job specs

Returns custom-job specs

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new job-spec

Creates a new job-spec

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-specs"
required
object
code
required
string <= 999999 characters
name
required
string <= 255 characters [a-zA-Z0-9-_]+
organization-id
required
string <uuid>
args
object
args-schema
object
branch
string <= 255 characters
class-name
string <= 255 characters
dbm-database-id
string <uuid>
download-type
string
Default: "text"
Enum: "binary" "text"
dynamic-scope
boolean
Default: false
log-level
string
Default: "warning"
Enum: "critical" "debug" "error" "info" "warning"
monitored
boolean
Default: false
path
string <= 255 characters
pylon-report-spec-id
string <uuid>
repository-id
string <uuid>
schedule-args
object
schedule-daily
boolean
schedule-rrule
string <rrule>
schedule-start
string <datetime>
schedule-timezone
string <timezone>
scopes
Array of strings[ items [ 1 .. 64 ] characters ]
user-required
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes an existing job-spec

Deletes an existing job-spec

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific job-spec

Returns specific job-spec

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing job-spec

Modifies an existing job-spec

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-specs"
required
object
args
object
args-schema
object
branch
string <= 255 characters
class-name
string <= 255 characters
code
string <= 999999 characters
dbm-database-id
string <uuid>
download-type
string
Enum: "binary" "text"
dynamic-scope
boolean
log-level
string
Enum: "critical" "debug" "error" "info" "warning"
monitored
boolean
name
string <= 255 characters [a-zA-Z0-9-_]+
path
string <= 255 characters
null or string
Any of
null
repository-id
string <uuid>
null or object
Any of
null
schedule-daily
boolean
schedule-rrule
string <rrule>
schedule-start
string <datetime>
string or null
Any of
string <timezone>
scopes
Array of strings[ items [ 1 .. 64 ] characters ]
user-required
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Sync job-spec with repository

Sync job-spec with repository

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-table-accesses

/v1/customjob-table-accesses/

query Parameters
spec-id
required
string <uuid>
Example: spec-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/customjob-table-accesses/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-table-accesses"
required
object
spec-id
required
string <uuid>
table-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-table-accesses/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-table-accesses/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-table-queries

/v1/customjob-table-queries/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/customjob-table-queries/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-table-queries"
required
object
args
required
Array of strings[ items <= 4096 characters ]
organization-id
required
string <= 64 characters
query
required
string <= 4096 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-table-queries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-tables

/v1/customjob-tables/

query Parameters
filter[name]
string <= 64 characters
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
spec-id
string <uuid>
Example: spec-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/customjob-tables/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-tables"
required
object
name
required
string <= 64 characters
required
object
required
Array of objects non-empty
Array (non-empty)
name
required
string [ 2 .. 64 ] characters [a-z][a-z0-9_]+
type
required
string
Enum: "boolean" "char" "date" "datetime" "decimal" "integer" "json" "uuid"
args
object
spec-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-tables/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-tables/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-tables/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-tables"
required
object
name
string <= 64 characters
schema
object
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-tables/{id}/delete-row/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
key
string <= 64 characters

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-tables/{id}/insert/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
values
required
object

Responses

Request samples

Content type
application/json
{
  • "values": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "key": "string"
}

/v1/customjob-tables/{id}/select/

path Parameters
id
required
string

Resource identifier

query Parameters
fields
required
Array of strings non-empty [[a-z][a-z0-9_]+]

Responses

Response samples

Content type
application/vnd.api+json
{
  • "rows": [
    ]
}

/v1/customjob-widget-outputs

/v1/customjob-widget-outputs/

query Parameters
widget-id
required
string <uuid>
Example: widget-id=11111111-1111-1111-1111-111111111111
filter[state]
string
Enum: "completed" "created" "failed" "running"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/customjob-widget-outputs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-widget-outputs/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "expiration-time": 0,
  • "url": "string"
}

/v1/customjob-widgetlogs

/v1/customjob-widgetlogs/

query Parameters
widget-id
required
string <uuid>
Example: widget-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/customjob-widgetlogs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-widgets

Returns widgets

Returns widgets

query Parameters
dashboard-id
string <uuid>
Example: dashboard-id=11111111-1111-1111-1111-111111111111
filter[job-spec-id]
string <uuid>
Example: filter[job-spec-id]=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new widget

Creates a new widget

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-widgets"
required
object
dashboard-id
required
string <uuid>
name
required
string <= 255 characters
args
object
debug
boolean
Default: false
height
integer
location-x
integer [ 0 .. 99999 ]
location-y
integer [ 0 .. 99999 ]
pylon-viewer-spec-id
string <uuid>
report-id
string <uuid>
spec-id
string <uuid>
title
string <= 255 characters
FormSchema (object) or FormSchemaV2 (object)
Any of
order
required
Array of strings[ items <= 999 characters ]
properties
required
object
required
required
Array of strings[ items <= 999 characters ]
type
required
string
Value: "object"
additionalProperties
boolean
GridLayoutSchema (object) (LayoutSchema)
Array of objects (FormSchemaLimit)

Used to define validation limits between properties

Array of objects (SectionSchema)
width
integer
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes an existing widget

Deletes an existing widget

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific widget

Returns specific widget

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing widget

Modifies an existing widget

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-widgets"
required
object
args
object
debug
boolean
height
integer
location-x
integer [ 0 .. 99999 ]
location-y
integer [ 0 .. 99999 ]
name
string <= 255 characters
null or string
Any of
null
report-id
string <uuid>
spec-id
string <uuid>
title
string <= 255 characters
object (FormSchema)
order
required
Array of strings[ items <= 999 characters ]
properties
required
object
required
required
Array of strings[ items <= 999 characters ]
type
required
string
Value: "object"
additionalProperties
boolean
GridLayoutSchema (object) (LayoutSchema)
Array of objects (FormSchemaLimit)

Used to define validation limits between properties

Array of objects (SectionSchema)
width
integer
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-widgets/{id}/action/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
args
object
scope
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "args": { },
  • "scope": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-widgets/{id}/get-deferred-output/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
args
object
scope
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "args": { },
  • "scope": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-widgets/{id}/get-deferred-raw-data/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
args
object
scope
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "args": { },
  • "scope": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-widgets/{id}/get-output/ Deprecated

path Parameters
id
required
string

Resource identifier

query Parameters
args
object
scope
string <uuid>
Example: scope=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{ }

/v1/customjob-widgets/{id}/get-raw-data/ Deprecated

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/customjob-widgets/{id}/refresh/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
args
object

Responses

Request samples

Content type
application/json
{
  • "args": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/customjob-widgetspecs

Returns widget specs

Returns widget specs

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[job-spec-id]
string <uuid>
Example: filter[job-spec-id]=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new widget-spec

Creates a new widget-spec

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-widgetspecs"
required
object
job-spec-id
required
string <uuid>
name
required
string <= 255 characters
organization-id
required
string <uuid>
allow-refresh
boolean
Default: false
args-schema
object
job-scope
string <= 255 characters
job-spec-class-name
string <= 255 characters
layout-schema
object
output-type
string
Enum: "graph" "html" "markdown" "metric" "table"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes an existing widget-spec

Deletes an existing widget-spec

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific widget-spec

Returns specific widget-spec

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing widget-spec

Modifies an existing widget-spec

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-widgetspecs"
required
object
allow-refresh
boolean
args-schema
object
job-scope
string <= 255 characters
job-spec-class-name
string <= 255 characters
job-spec-id
string <uuid>
layout-schema
object
name
string <= 255 characters
output-type
string
Enum: "graph" "html" "markdown" "metric" "table"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbd-loaders

/v1/dbd-loaders/

query Parameters
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/dbd-loaders/

Request Body schema: application/json
required
object
type
required
string
Value: "dbd-loaders"
required
object
args
required
object
name
required
string <= 255 characters
type
required
string
Enum: "basic_aurora" "incremental_aurora" "parallel_aurora"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbd-loaders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/dbd-loaders/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbd-loaders/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "dbd-loaders"
required
object
args
required
object
name
required
string <= 255 characters
type
required
string
Enum: "basic_aurora" "incremental_aurora" "parallel_aurora"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbm-clusters

/v1/dbm-clusters/

query Parameters
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/dbm-clusters/

Request Body schema: application/json
required
object
type
required
string
Value: "dbm-clusters"
required
object
db-host
required
string <= 255 characters
db-name
required
string <= 255 characters
db-password
required
string <= 255 characters
db-port
required
integer
db-username
required
string <= 255 characters
name
required
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbm-clusters/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/dbm-clusters/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbm-clusters/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "dbm-clusters"
required
object
db-host
string <= 255 characters
db-name
string <= 255 characters
db-password
string <= 255 characters
db-port
integer
db-username
string <= 255 characters
name
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbm-clusters/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbm-databases

/v1/dbm-databases/

query Parameters
filter[db-name]
string <= 255 characters
filter[dbm-cluster-id]
string <uuid>
Example: filter[dbm-cluster-id]=11111111-1111-1111-1111-111111111111
filter[managed]
boolean
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/dbm-databases/

Request Body schema: application/json
required
object
type
required
string
Value: "dbm-databases"
required
object
db-host
required
string <= 255 characters
db-port
required
integer
dbm-cluster-id
required
string <uuid>
organization-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbm-databases/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/dbm-databases/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbm-rollups

/v1/dbm-rollups/

query Parameters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/dbt-projects

Returns projects

Returns projects

query Parameters
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new project

Creates a new project

Request Body schema: application/json
required
object
type
required
string
Value: "dbt-projects"
required
object
name
required
string <= 255 characters
personal-access-token
string <= 255 characters
private-key
string <= 9999 characters
schedule-daily
boolean
Default: false
type
string
Default: "git"
Enum: "archive" "git"
url
string <= 255 characters
username
string <= 64 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes an existing project

Deletes an existing project

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific project

Returns specific project

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing project

Modifies an existing project

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "dbt-projects"
required
object
name
string <= 255 characters
personal-access-token
string <= 255 characters
private-key
string <= 9999 characters
schedule-daily
boolean
url
string <= 255 characters
username
string <= 64 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbt-projects/{id}/get-docs-info/

path Parameters
id
required
string

Resource identifier

query Parameters
target
string
Default: "prod"
Enum: "dev" "prod"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "docs-url": "string",
  • "expiration-time": 0
}

Upload .tgz file. Archive should have no prefix, e

Upload .tgz file. Archive should have no prefix, e.g. tar cvfz project.tgz -C /path/project .

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "expiration-time": 0,
  • "upload-data": { },
  • "upload-url": "string"
}

/v1/dbt-projects/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/dbt-runs

Returns runs

Returns runs

query Parameters
project-id
required
string <uuid>
Example: project-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new run

Creates a new run

Request Body schema: application/json
required
object
type
required
string
Value: "dbt-runs"
required
object
project-id
required
string <uuid>
branch
string <= 255 characters
select
string <= 255 characters
target
string
Default: "dev"
Enum: "dev" "prod"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes an existing run

Deletes an existing run

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific run

Returns specific run

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/llm-individual-runs

/v1/llm-individual-runs/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/llm-individual-runs/

Request Body schema: application/json
required
object
type
required
string
Value: "llm-individual-runs"
required
object
individual-id
required
string <uuid>
question
required
string <= 300 characters
collector-params
object
collectors
Array of strings non-empty
Items Enum: "caredb.AppointmentCollector" "caredb.ConditionCollector" "caredb.DemographicCollector" "caredb.EncounterCollector" "courier.MessageCollector" "lachesis.BloodPressureCollector" "lachesis.BodyMassCollector" "lachesis.PulseCollector" "lachesis.StepCollector"
config
object
model
string
Default: "claude-3-sonnet"
Enum: "claude-1-instant" "claude-3-opus" "claude-3-sonnet" "titan-express"
organization-id
string <uuid>
vector-chunk-only
boolean
Default: false
vector-limit
integer
Default: 0
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/llm-individual-runs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/llm-individual-runs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/llm-sql-queries

/v1/llm-sql-queries/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/llm-sql-queries/

Request Body schema: application/json
required
object
type
required
string
Value: "llm-sql-queries"
required
object
organization-id
required
string <uuid>
question
required
string <= 300 characters
config
object
model
string
Default: "claude-3-sonnet"
Enum: "claude-1-instant" "claude-3-opus" "claude-3-sonnet" "titan-express"
table-group-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/llm-sql-queries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/llm-sql-queries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/llm-vector-entries

/v1/llm-vector-entries/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
query
required
string <= 1024 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/llm-vector-entries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/loader-runs

/v1/loader-runs/

query Parameters
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/purge-data

/v1/purge-data/

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/purge-data/

Request Body schema: application/json
required
object
type
required
string
Value: "system-purges"
required
object
entity-id
required
string <= 255 characters
entity-type
required
string
Enum: "individual" "organization" "user"
reference-id
required
string <= 255 characters
request-id
required
string <= 255 characters
archive
boolean
Default: false
property name*
additional property
any
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/sniffers

/v1/sniffers/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/sniffers/

Request Body schema: application/json
required
object
type
required
string
Value: "sniffers"
required
object
user-id
required
string <uuid>
valid-until
required
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/get-logs/

path Parameters
id
required
string

Resource identifier

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/tasks

/v1/tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}