Skip to main content
API docs by Redocly

Daikoku Admin API (19.1.0-dev)

Download OpenAPI specification:Download

MAIF open source team: oss@maif.fr License: Apache 2.0

Admin API of Daikoku

Find out more about Daikoku

tenant

delete a tenant

path Parameters
id
required
string

The ID of the tenant to delete

Responses

Response samples

Content type
application/json
{
  • "done": true
}

update a tenant with JSON patch or by merging JSON object

path Parameters
id
required
string

The tenant ID to update

Request Body schema: application/json
required

the patch to update the tenant or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

update a tenant

path Parameters
id
required
string

The ID of the tenant to update

Request Body schema: application/json
required

the ID of the tenant to update

_id
required
string
enabled
required
boolean
name
required
string
domain
string or null
contact
required
string
DaikokuStyle (object) or null
defaultLanguage
string or null
Array of objects or null (OtoroshiSettings)
MailerSettings.ConsoleMailerSettings (object) or MailerSettings.MailgunSettings (object) or MailerSettings.MailjetSettings (object) or MailerSettings.SimpleSMTPSettings (object) or MailerSettings.SendgridSettings (object) or null
S3Configuration (object) or null
authProvider
string or null
Enum: "local" "otoroshi" "ldap" "oauth2" null
authProviderSettings
object
object (AuditTrailConfig)

AuditTrailConfig

isPrivate
boolean or null
adminApi
required
string
adminSubscriptions
Array of strings
creationSecurity
boolean or null
subscriptionSecurity
boolean or null
apiReferenceHideForGuest
boolean or null
defaultMessage
string or null
tenantMode
string or null
Enum: "default" "maintenance" "construction" "translation" null
aggregationApiKeysSecurity
boolean or null
robotTxt
string or null
Array of ThirdPartyPaymentSettings.StripeSettings (object) or null
display
string or null
Enum: "default" "environment" null
environments
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "enabled": true,
  • "name": "string",
  • "domain": "string",
  • "contact": "string",
  • "style": {
    },
  • "defaultLanguage": "string",
  • "otoroshiSettings": [
    ],
  • "mailerSettings": {
    },
  • "bucketSettings": {
    },
  • "authProvider": "local",
  • "authProviderSettings": { },
  • "auditTrailConfig": {
    },
  • "isPrivate": true,
  • "adminApi": "string",
  • "adminSubscriptions": [
    ],
  • "creationSecurity": true,
  • "subscriptionSecurity": true,
  • "apiReferenceHideForGuest": true,
  • "defaultMessage": "string",
  • "tenantMode": "default",
  • "aggregationApiKeysSecurity": true,
  • "robotTxt": "string",
  • "thirdPartyPaymentSettings": [
    ],
  • "display": "default",
  • "environments": [
    ]
}

Response samples

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

read a tenant

path Parameters
id
required
string

The ID of the tenant to retrieve

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "enabled": true,
  • "name": "string",
  • "domain": "string",
  • "contact": "string",
  • "style": {
    },
  • "defaultLanguage": "string",
  • "otoroshiSettings": [
    ],
  • "mailerSettings": {
    },
  • "bucketSettings": {
    },
  • "authProvider": "local",
  • "authProviderSettings": { },
  • "auditTrailConfig": {
    },
  • "isPrivate": true,
  • "adminApi": "string",
  • "adminSubscriptions": [
    ],
  • "creationSecurity": true,
  • "subscriptionSecurity": true,
  • "apiReferenceHideForGuest": true,
  • "defaultMessage": "string",
  • "tenantMode": "default",
  • "aggregationApiKeysSecurity": true,
  • "robotTxt": "string",
  • "thirdPartyPaymentSettings": [
    ],
  • "display": "default",
  • "environments": [
    ]
}

read all tenant

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create a tenant

Request Body schema: application/json
required

the tenant to create

_id
required
string
enabled
required
boolean
name
required
string
domain
string or null
contact
required
string
DaikokuStyle (object) or null
defaultLanguage
string or null
Array of objects or null (OtoroshiSettings)
MailerSettings.ConsoleMailerSettings (object) or MailerSettings.MailgunSettings (object) or MailerSettings.MailjetSettings (object) or MailerSettings.SimpleSMTPSettings (object) or MailerSettings.SendgridSettings (object) or null
S3Configuration (object) or null
authProvider
string or null
Enum: "local" "otoroshi" "ldap" "oauth2" null
authProviderSettings
object
object (AuditTrailConfig)

AuditTrailConfig

isPrivate
boolean or null
adminApi
required
string
adminSubscriptions
Array of strings
creationSecurity
boolean or null
subscriptionSecurity
boolean or null
apiReferenceHideForGuest
boolean or null
defaultMessage
string or null
tenantMode
string or null
Enum: "default" "maintenance" "construction" "translation" null
aggregationApiKeysSecurity
boolean or null
robotTxt
string or null
Array of ThirdPartyPaymentSettings.StripeSettings (object) or null
display
string or null
Enum: "default" "environment" null
environments
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "enabled": true,
  • "name": "string",
  • "domain": "string",
  • "contact": "string",
  • "style": {
    },
  • "defaultLanguage": "string",
  • "otoroshiSettings": [
    ],
  • "mailerSettings": {
    },
  • "bucketSettings": {
    },
  • "authProvider": "local",
  • "authProviderSettings": { },
  • "auditTrailConfig": {
    },
  • "isPrivate": true,
  • "adminApi": "string",
  • "adminSubscriptions": [
    ],
  • "creationSecurity": true,
  • "subscriptionSecurity": true,
  • "apiReferenceHideForGuest": true,
  • "defaultMessage": "string",
  • "tenantMode": "default",
  • "aggregationApiKeysSecurity": true,
  • "robotTxt": "string",
  • "thirdPartyPaymentSettings": [
    ],
  • "display": "default",
  • "environments": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "enabled": true,
  • "name": "string",
  • "domain": "string",
  • "contact": "string",
  • "style": {
    },
  • "defaultLanguage": "string",
  • "otoroshiSettings": [
    ],
  • "mailerSettings": {
    },
  • "bucketSettings": {
    },
  • "authProvider": "local",
  • "authProviderSettings": { },
  • "auditTrailConfig": {
    },
  • "isPrivate": true,
  • "adminApi": "string",
  • "adminSubscriptions": [
    ],
  • "creationSecurity": true,
  • "subscriptionSecurity": true,
  • "apiReferenceHideForGuest": true,
  • "defaultMessage": "string",
  • "tenantMode": "default",
  • "aggregationApiKeysSecurity": true,
  • "robotTxt": "string",
  • "thirdPartyPaymentSettings": [
    ],
  • "display": "default",
  • "environments": [
    ]
}

user

delete a user

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

update a user with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the user or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

update a user

path Parameters
id
required
string
Request Body schema: application/json
required

the user to update

_id
required
string
tenants
Array of strings or null
origins
Array of strings or null
Enum: "local" "otoroshi" "ldap" "oauth2"
name
required
string
email
required
string
picture
string or null
pictureFromProvider
boolean or null
isDaikokuAdmin
boolean or null
password
string or null

optionnal value but required in case of tenant has a Local AuthProvider

hardwareKeyRegistrations
Array of objects or null
lastTenant
string or null
metadata
object or null
defaultLanguage
string or null
starredApis
Array of strings or null
TwoFactorAuthentication (object) or null
UserInvitation (object) or null

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "tenants": [
    ],
  • "origins": [
    ],
  • "name": "string",
  • "email": "string",
  • "picture": "string",
  • "pictureFromProvider": true,
  • "isDaikokuAdmin": true,
  • "password": "string",
  • "hardwareKeyRegistrations": [
    ],
  • "lastTenant": "string",
  • "metadata": { },
  • "defaultLanguage": "string",
  • "starredApis": [
    ],
  • "twoFactorAuthentication": {
    },
  • "invitation": {
    }
}

Response samples

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

read a user

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "tenants": [
    ],
  • "origins": [
    ],
  • "name": "string",
  • "email": "string",
  • "picture": "string",
  • "pictureFromProvider": true,
  • "isDaikokuAdmin": true,
  • "password": "string",
  • "hardwareKeyRegistrations": [
    ],
  • "lastTenant": "string",
  • "metadata": { },
  • "defaultLanguage": "string",
  • "starredApis": [
    ],
  • "twoFactorAuthentication": {
    },
  • "invitation": {
    }
}

read all user

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a user

Request Body schema: application/json
required

the user to create

_id
required
string
tenants
Array of strings or null
origins
Array of strings or null
Enum: "local" "otoroshi" "ldap" "oauth2"
name
required
string
email
required
string
picture
string or null
pictureFromProvider
boolean or null
isDaikokuAdmin
boolean or null
password
string or null

optionnal value but required in case of tenant has a Local AuthProvider

hardwareKeyRegistrations
Array of objects or null
lastTenant
string or null
metadata
object or null
defaultLanguage
string or null
starredApis
Array of strings or null
TwoFactorAuthentication (object) or null
UserInvitation (object) or null

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "tenants": [
    ],
  • "origins": [
    ],
  • "name": "string",
  • "email": "string",
  • "picture": "string",
  • "pictureFromProvider": true,
  • "isDaikokuAdmin": true,
  • "password": "string",
  • "hardwareKeyRegistrations": [
    ],
  • "lastTenant": "string",
  • "metadata": { },
  • "defaultLanguage": "string",
  • "starredApis": [
    ],
  • "twoFactorAuthentication": {
    },
  • "invitation": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "tenants": [
    ],
  • "origins": [
    ],
  • "name": "string",
  • "email": "string",
  • "picture": "string",
  • "pictureFromProvider": true,
  • "isDaikokuAdmin": true,
  • "password": "string",
  • "hardwareKeyRegistrations": [
    ],
  • "lastTenant": "string",
  • "metadata": { },
  • "defaultLanguage": "string",
  • "starredApis": [
    ],
  • "twoFactorAuthentication": {
    },
  • "invitation": {
    }
}

team

delete a team

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

update a team with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the team or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

update a team

path Parameters
id
required
string
Request Body schema: application/json
required

the team to update

_id
required
string
_humanReadableId
string
_tenant
required
string
type
required
string
Enum: "Personal" "Organization" "Admin"
name
required
string
description
string or null
contact
required
string
avatar
string or null
Array of objects (UserWithPermission)
Array of objects or null
apiKeyVisibility
string
Enum: "Administrator" "ApiEditor" "User"
metadata
object or null
apisCreationPermission
boolean or null
verified
required
boolean

Responses

Request samples

Content type
application/json
{
  • "_id": "team-weather",
  • "_tenant": "default",
  • "type": "Organization",
  • "name": "Weather",
  • "contact": "weather@acme.io",
  • "verified": true
}

Response samples

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

read a team

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "team-weather",
  • "_tenant": "default",
  • "type": "Organization",
  • "name": "Weather",
  • "contact": "weather@acme.io",
  • "verified": true
}

read all team

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a team

Request Body schema: application/json
required

the team to create

_id
required
string
_humanReadableId
string
_tenant
required
string
type
required
string
Enum: "Personal" "Organization" "Admin"
name
required
string
description
string or null
contact
required
string
avatar
string or null
Array of objects (UserWithPermission)
Array of objects or null
apiKeyVisibility
string
Enum: "Administrator" "ApiEditor" "User"
metadata
object or null
apisCreationPermission
boolean or null
verified
required
boolean

Responses

Request samples

Content type
application/json
{
  • "_id": "team-weather",
  • "_tenant": "default",
  • "type": "Organization",
  • "name": "Weather",
  • "contact": "weather@acme.io",
  • "verified": true
}

Response samples

Content type
application/json
{
  • "_id": "team-weather",
  • "_tenant": "default",
  • "type": "Organization",
  • "name": "Weather",
  • "contact": "weather@acme.io",
  • "verified": true
}

api

delete a api

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

update a api with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the api or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

update a api

path Parameters
id
required
string
Request Body schema: application/json
required

the api to update

_id
required
string
_humanReadableId
string
_tenant
required
string
team
required
string
name
required
string
lastUpdate
integer <timestamp>
createdAt
integer <timestamp>
description
string or null
smallDescription
string or null
customHeaderCmsPage
string or null
descriptionCmsPage
string or null
header
string or null
image
string or null
currentVersion
string
supportedVersions
Array of strings
isDefault
boolean or null
Testing (object) or null
object (ApiDocumentation)

ApiDocumentation

SwaggerAccess (object) or null
tags
Array of strings or null
categories
Array of strings or null
visibility
string
Enum: "Public" "Private" "PublicWithAuthorizations" "AdminOnly"
possibleUsagePlans
Array of strings
defaultUsagePlan
string or null
authorizedTeams
Array of strings or null
posts
Array of strings or null
issues
Array of strings or null
Array of objects or null (ApiIssueTag)
stars
integer <int32>
parent
string or null
apis
Array of strings or null
state
string
Enum: "created" "published" "blocked" "deprecated"
object

Responses

Request samples

Content type
application/json
{
  • "_id": "api-weather",
  • "_tenant": "default",
  • "team": "team-weather",
  • "name": "Weather API"
}

Response samples

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

read a api

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "api-weather",
  • "_tenant": "default",
  • "team": "team-weather",
  • "name": "Weather API"
}

read all api

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a api

Request Body schema: application/json
required

the api to create

_id
required
string
_humanReadableId
string
_tenant
required
string
team
required
string
name
required
string
lastUpdate
integer <timestamp>
createdAt
integer <timestamp>
description
string or null
smallDescription
string or null
customHeaderCmsPage
string or null
descriptionCmsPage
string or null
header
string or null
image
string or null
currentVersion
string
supportedVersions
Array of strings
isDefault
boolean or null
Testing (object) or null
object (ApiDocumentation)

ApiDocumentation

SwaggerAccess (object) or null
tags
Array of strings or null
categories
Array of strings or null
visibility
string
Enum: "Public" "Private" "PublicWithAuthorizations" "AdminOnly"
possibleUsagePlans
Array of strings
defaultUsagePlan
string or null
authorizedTeams
Array of strings or null
posts
Array of strings or null
issues
Array of strings or null
Array of objects or null (ApiIssueTag)
stars
integer <int32>
parent
string or null
apis
Array of strings or null
state
string
Enum: "created" "published" "blocked" "deprecated"
object

Responses

Request samples

Content type
application/json
{
  • "_id": "api-weather",
  • "_tenant": "default",
  • "team": "team-weather",
  • "name": "Weather API"
}

Response samples

Content type
application/json
{
  • "_id": "api-weather",
  • "_tenant": "default",
  • "team": "team-weather",
  • "name": "Weather API"
}

api-subscription

delete a api-subscription

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

update a api-subscription with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the api-subscription or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

update a api-subscription

path Parameters
id
required
string
Request Body schema: application/json
required

the api-subscription to update

_id
required
string
_tenant
required
string
keyring
required
string
plan
required
string
team
required
string
api
required
string
createdAt
required
integer <timestamp>
validUntil
integer or null <timestamp>
by
required
string
customName
string or null
adminCustomName
string or null
enabled
boolean or null
customMetadata
object or null
metadata
object or null
tags
Array of strings
customMaxPerSecond
integer or null <int64>
customMaxPerDay
integer or null <int64>
customMaxPerMonth
integer or null <int64>
customReadOnly
boolean or null
state
string
Enum: "active" "blocked"
blockedBy
Array of strings
Items Enum: "owner" "lifecycle"
ThirdPartySubscriptionInformations.Stripe (object)

Responses

Request samples

Content type
application/json
{
  • "_id": "subscription-weather",
  • "_tenant": "default",
  • "keyring": "keyring-weather",
  • "plan": "plan-weather-free",
  • "team": "team-weather",
  • "api": "api-weather",
  • "createdAt": 1759190400000,
  • "by": "user-admin"
}

Response samples

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

read a api-subscription

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "subscription-weather",
  • "_tenant": "default",
  • "keyring": "keyring-weather",
  • "plan": "plan-weather-free",
  • "team": "team-weather",
  • "api": "api-weather",
  • "createdAt": 1759190400000,
  • "by": "user-admin"
}

read all api-subscription

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a api-subscription

Request Body schema: application/json
required

the api-subscription to create

_id
required
string
_tenant
required
string
keyring
required
string
plan
required
string
team
required
string
api
required
string
createdAt
required
integer <timestamp>
validUntil
integer or null <timestamp>
by
required
string
customName
string or null
adminCustomName
string or null
enabled
boolean or null
customMetadata
object or null
metadata
object or null
tags
Array of strings
customMaxPerSecond
integer or null <int64>
customMaxPerDay
integer or null <int64>
customMaxPerMonth
integer or null <int64>
customReadOnly
boolean or null
state
string
Enum: "active" "blocked"
blockedBy
Array of strings
Items Enum: "owner" "lifecycle"
ThirdPartySubscriptionInformations.Stripe (object)

Responses

Request samples

Content type
application/json
{
  • "_id": "subscription-weather",
  • "_tenant": "default",
  • "keyring": "keyring-weather",
  • "plan": "plan-weather-free",
  • "team": "team-weather",
  • "api": "api-weather",
  • "createdAt": 1759190400000,
  • "by": "user-admin"
}

Response samples

Content type
application/json
{
  • "_id": "subscription-weather",
  • "_tenant": "default",
  • "keyring": "keyring-weather",
  • "plan": "plan-weather-free",
  • "team": "team-weather",
  • "api": "api-weather",
  • "createdAt": 1759190400000,
  • "by": "user-admin"
}

api-documentation-page

delete a api-documentation-page

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

update a api-documentation-page with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the api-documentation-page or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

update a api-documentation-page

path Parameters
id
required
string
Request Body schema: application/json
required

the api-documentation-page to update

_id
required
string
_tenant
required
string
title
required
string
lastModificationAt
integer <timestamp>
content
string or null
contentType
string or null
remoteContentEnabled
boolean or null
remoteContentUrl
string or null
remoteContentHeaders
object or null
cmsPage
string or null
object

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "title": "string",
  • "lastModificationAt": 0,
  • "content": "string",
  • "contentType": "string",
  • "remoteContentEnabled": true,
  • "remoteContentUrl": "string",
  • "remoteContentHeaders": { },
  • "cmsPage": "string",
  • "metadata": {
    }
}

Response samples

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

read a api-documentation-page

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "title": "string",
  • "lastModificationAt": 0,
  • "content": "string",
  • "contentType": "string",
  • "remoteContentEnabled": true,
  • "remoteContentUrl": "string",
  • "remoteContentHeaders": { },
  • "cmsPage": "string",
  • "metadata": {
    }
}

read all api-documentation-page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a api-documentation-page

Request Body schema: application/json
required

the api-documentation-page to create

_id
required
string
_tenant
required
string
title
required
string
lastModificationAt
integer <timestamp>
content
string or null
contentType
string or null
remoteContentEnabled
boolean or null
remoteContentUrl
string or null
remoteContentHeaders
object or null
cmsPage
string or null
object

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "title": "string",
  • "lastModificationAt": 0,
  • "content": "string",
  • "contentType": "string",
  • "remoteContentEnabled": true,
  • "remoteContentUrl": "string",
  • "remoteContentHeaders": { },
  • "cmsPage": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "title": "string",
  • "lastModificationAt": 0,
  • "content": "string",
  • "contentType": "string",
  • "remoteContentEnabled": true,
  • "remoteContentUrl": "string",
  • "remoteContentHeaders": { },
  • "cmsPage": "string",
  • "metadata": {
    }
}

notification

delete a notification

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

read a notification

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "team": "string",
  • "sender": {
    },
  • "date": 0,
  • "notificationType": "AcceptOrReject",
  • "status": {
    },
  • "action": {
    }
}

read all notification

Responses

Response samples

Content type
application/json
[
  • {
    }
]

user-session

delete a user-session

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

read a user-session

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "sessionId": "string",
  • "userId": "string",
  • "userName": "string",
  • "userEmail": "string",
  • "impersonatorId": "string",
  • "impersonatorName": "string",
  • "impersonatorEmail": "string",
  • "impersonatorSessionId": "string",
  • "created": 0,
  • "ttl": 0,
  • "expires": 0
}

read all user-session

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api-key-consumption

delete a api-key-consumption

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

read a api-key-consumption

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "team": "string",
  • "api": "string",
  • "plan": "string",
  • "clientId": "string",
  • "hits": 0,
  • "globalInformations": {
    },
  • "quotas": {
    },
  • "billing": {
    },
  • "from": 0,
  • "to": 0,
  • "state": "completed"
}

read all api-key-consumption

Responses

Response samples

Content type
application/json
[
  • {
    }
]

audit-event

delete a audit-event

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

read a audit-event

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

read all audit-event

Responses

Response samples

Content type
application/json
[
  • { }
]

message

delete a message

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

read a message

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "messageType": {
    },
  • "chat": "string",
  • "participants": [
    ],
  • "readBy": [
    ],
  • "date": 0,
  • "sender": "string",
  • "message": "string",
  • "closed": 0,
  • "send": true
}

read all message

Responses

Response samples

Content type
application/json
[
  • {
    }
]

issue

delete a issue

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

update a issue with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the issue or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

update a issue

path Parameters
id
required
string
Request Body schema: application/json
required

the issue to update

_id
required
string
seqId
integer or null <int32>
_tenant
required
string
title
required
string
tags
Array of strings or null
open
boolean or null
createdAt
integer or null <timestamp>
closedAt
integer or null <timestamp>
by
required
string
Array of objects (ApiIssueComment)
lastModificationAt
integer or null <timestamp>
apiVersion
string or null

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "seqId": 0,
  • "_tenant": "string",
  • "title": "string",
  • "tags": [
    ],
  • "open": true,
  • "createdAt": 0,
  • "closedAt": 0,
  • "by": "string",
  • "comments": [
    ],
  • "lastModificationAt": 0,
  • "apiVersion": "string"
}

Response samples

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

read a issue

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "seqId": 0,
  • "_tenant": "string",
  • "title": "string",
  • "tags": [
    ],
  • "open": true,
  • "createdAt": 0,
  • "closedAt": 0,
  • "by": "string",
  • "comments": [
    ],
  • "lastModificationAt": 0,
  • "apiVersion": "string"
}

read all issue

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a issue

Request Body schema: application/json
required

the issue to create

_id
required
string
seqId
integer or null <int32>
_tenant
required
string
title
required
string
tags
Array of strings or null
open
boolean or null
createdAt
integer or null <timestamp>
closedAt
integer or null <timestamp>
by
required
string
Array of objects (ApiIssueComment)
lastModificationAt
integer or null <timestamp>
apiVersion
string or null

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "seqId": 0,
  • "_tenant": "string",
  • "title": "string",
  • "tags": [
    ],
  • "open": true,
  • "createdAt": 0,
  • "closedAt": 0,
  • "by": "string",
  • "comments": [
    ],
  • "lastModificationAt": 0,
  • "apiVersion": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "seqId": 0,
  • "_tenant": "string",
  • "title": "string",
  • "tags": [
    ],
  • "open": true,
  • "createdAt": 0,
  • "closedAt": 0,
  • "by": "string",
  • "comments": [
    ],
  • "lastModificationAt": 0,
  • "apiVersion": "string"
}

post

delete a post

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

update a post with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the post or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

update a post

path Parameters
id
required
string
Request Body schema: application/json
required

the post to update

_id
required
string
_tenant
required
string
title
required
string
lastModificationAt
required
integer <timestamp>
content
string or null

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "title": "string",
  • "lastModificationAt": 0,
  • "content": "string"
}

Response samples

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

read a post

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "title": "string",
  • "lastModificationAt": 0,
  • "content": "string"
}

read all post

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a post

Request Body schema: application/json
required

the post to create

_id
required
string
_tenant
required
string
title
required
string
lastModificationAt
required
integer <timestamp>
content
string or null

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "title": "string",
  • "lastModificationAt": 0,
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "title": "string",
  • "lastModificationAt": 0,
  • "content": "string"
}

translation

delete a translation

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

update a translation with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the translation or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

update a translation

path Parameters
id
required
string
Request Body schema: application/json
required

the translation to update

_id
required
string
_tenant
required
string
language
required
string
key
required
string
value
required
string
lastModificationAt
integer or null <timestamp>

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "language": "string",
  • "key": "string",
  • "value": "string",
  • "lastModificationAt": 0
}

Response samples

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

read a translation

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "language": "string",
  • "key": "string",
  • "value": "string",
  • "lastModificationAt": 0
}

read all translation

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a translation

Request Body schema: application/json
required

the translation to create

_id
required
string
_tenant
required
string
language
required
string
key
required
string
value
required
string
lastModificationAt
integer or null <timestamp>

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "language": "string",
  • "key": "string",
  • "value": "string",
  • "lastModificationAt": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "language": "string",
  • "key": "string",
  • "value": "string",
  • "lastModificationAt": 0
}

usage-plan

delete a usage-plan

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

update a usage-plan with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the usage-plan or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

update a usage-plan

path Parameters
id
required
string
Request Body schema: application/json
required

the usage-plan to update

_id
required
string
_tenant
required
string
Currency (object) or null
customName
required
string
customDescription
string or null
OtoroshiTarget (object) or null
BillingDuration (object) or null
allowMultipleKeys
boolean or null
visibility
string
Enum: "Public" "Private" "Admin"
authorizedTeams
Array of strings
autoRotation
boolean or null
required
object
integrationProcess
string
Enum: "Automatic" "ApiKey"
aggregationApiKeysSecurity
boolean or null
SwaggerAccess (object) or null
Testing (object) or null
ApiDocumentation (object) or null
maxPerSecond
integer or null <int64>
maxPerDay
integer or null <int64>
maxPerMonth
integer or null <int64>
costPerMonth
number or null <float64>
costPerRequest
number or null <float64>
BillingDuration (object) or null
object
PaymentSettings.Stripe (object) or null

Responses

Request samples

Content type
application/json
{
  • "_id": "plan-weather-free",
  • "_tenant": "default",
  • "customName": "Free",
  • "subscriptionProcess": {
    }
}

Response samples

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

read a usage-plan

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "plan-weather-free",
  • "_tenant": "default",
  • "customName": "Free",
  • "subscriptionProcess": {
    }
}

read all usage-plan

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a usage-plan

Request Body schema: application/json
required

the usage-plan to create

_id
required
string
_tenant
required
string
Currency (object) or null
customName
required
string
customDescription
string or null
OtoroshiTarget (object) or null
BillingDuration (object) or null
allowMultipleKeys
boolean or null
visibility
string
Enum: "Public" "Private" "Admin"
authorizedTeams
Array of strings
autoRotation
boolean or null
required
object
integrationProcess
string
Enum: "Automatic" "ApiKey"
aggregationApiKeysSecurity
boolean or null
SwaggerAccess (object) or null
Testing (object) or null
ApiDocumentation (object) or null
maxPerSecond
integer or null <int64>
maxPerDay
integer or null <int64>
maxPerMonth
integer or null <int64>
costPerMonth
number or null <float64>
costPerRequest
number or null <float64>
BillingDuration (object) or null
object
PaymentSettings.Stripe (object) or null

Responses

Request samples

Content type
application/json
{
  • "_id": "plan-weather-free",
  • "_tenant": "default",
  • "customName": "Free",
  • "subscriptionProcess": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "plan-weather-free",
  • "_tenant": "default",
  • "customName": "Free",
  • "subscriptionProcess": {
    }
}

subscription-demand

delete a subscription-demand

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

update a subscription-demand with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the subscription-demand or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

update a subscription-demand

path Parameters
id
required
string
Request Body schema: application/json
required

the subscription-demand to update

_id
required
string
_tenant
required
string
api
required
string
plan
required
string
required
Array of SubscriptionDemandStep.Email (object) or SubscriptionDemandStep.TeamAdmin (object) or SubscriptionDemandStep.Payment (object) or SubscriptionDemandStep.HttpRequest (object)
required
object (SubscriptionDemandState)

SubscriptionDemandStep

team
required
string
from
required
string
date
required
integer <timestamp>
motivation
string or null
parentSubscriptionId
string or null
customReadOnly
boolean or null
customMetadata
object
customMaxPerSecond
integer or null <int64>
customMaxPerDay
integer or null <int64>
customMaxPerMonth
integer or null <int64>
adminCustomName
string or null

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "api": "string",
  • "plan": "string",
  • "steps": [
    ],
  • "state": {
    },
  • "team": "string",
  • "from": "string",
  • "date": 0,
  • "motivation": "string",
  • "parentSubscriptionId": "string",
  • "customReadOnly": true,
  • "customMetadata": { },
  • "customMaxPerSecond": 0,
  • "customMaxPerDay": 0,
  • "customMaxPerMonth": 0,
  • "adminCustomName": "string"
}

Response samples

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

read a subscription-demand

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "api": "string",
  • "plan": "string",
  • "steps": [
    ],
  • "state": {
    },
  • "team": "string",
  • "from": "string",
  • "date": 0,
  • "motivation": "string",
  • "parentSubscriptionId": "string",
  • "customReadOnly": true,
  • "customMetadata": { },
  • "customMaxPerSecond": 0,
  • "customMaxPerDay": 0,
  • "customMaxPerMonth": 0,
  • "adminCustomName": "string"
}

read all subscription-demand

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a subscription-demand

Request Body schema: application/json
required

the subscription-demand to create

_id
required
string
_tenant
required
string
api
required
string
plan
required
string
required
Array of SubscriptionDemandStep.Email (object) or SubscriptionDemandStep.TeamAdmin (object) or SubscriptionDemandStep.Payment (object) or SubscriptionDemandStep.HttpRequest (object)
required
object (SubscriptionDemandState)

SubscriptionDemandStep

team
required
string
from
required
string
date
required
integer <timestamp>
motivation
string or null
parentSubscriptionId
string or null
customReadOnly
boolean or null
customMetadata
object
customMaxPerSecond
integer or null <int64>
customMaxPerDay
integer or null <int64>
customMaxPerMonth
integer or null <int64>
adminCustomName
string or null

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "api": "string",
  • "plan": "string",
  • "steps": [
    ],
  • "state": {
    },
  • "team": "string",
  • "from": "string",
  • "date": 0,
  • "motivation": "string",
  • "parentSubscriptionId": "string",
  • "customReadOnly": true,
  • "customMetadata": { },
  • "customMaxPerSecond": 0,
  • "customMaxPerDay": 0,
  • "customMaxPerMonth": 0,
  • "adminCustomName": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "api": "string",
  • "plan": "string",
  • "steps": [
    ],
  • "state": {
    },
  • "team": "string",
  • "from": "string",
  • "date": 0,
  • "motivation": "string",
  • "parentSubscriptionId": "string",
  • "customReadOnly": true,
  • "customMetadata": { },
  • "customMaxPerSecond": 0,
  • "customMaxPerDay": 0,
  • "customMaxPerMonth": 0,
  • "adminCustomName": "string"
}

GraphQL

search with GraphQL

Request Body schema: application/json
required

GraphQL query

One of
query
string

Responses

Request samples

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

Response samples

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

search with GraphQL

Request Body schema: application/json
required

get GraphQL schema

One of
query
string

Responses

Request samples

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

Response samples

Content type
application/json
{ }

Integration ApiKey

get apikey from integration token

path Parameters
token
required
string

integration token

Responses

Response samples

Content type
application/json
{
  • "clientName": "string",
  • "clientId": "string",
  • "clientSecret": "string"
}

cms-page

read all cms pages

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a cms page

Request Body schema: application/json
required

the cms page to create

_id
required
string
_tenant
required
string
name
required
string
visible
boolean
authenticated
boolean
picture
string or null
tags
Array of strings
object
contentType
string
forwardRef
string or null
body
string
path
string or null
exact
boolean
lastPublishedDate
integer or null <timestamp>

Responses

Request samples

Content type
application/json
{
  • "_id": "page-weather-home",
  • "_tenant": "default",
  • "name": "Weather home"
}

Response samples

Content type
application/json
{
  • "_id": "page-weather-home",
  • "_tenant": "default",
  • "name": "Weather home"
}

read a cms page

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "page-weather-home",
  • "_tenant": "default",
  • "name": "Weather home"
}

update a cms page

path Parameters
id
required
string
Request Body schema: application/json
required

the cms page to update

_id
required
string
_tenant
required
string
name
required
string
visible
boolean
authenticated
boolean
picture
string or null
tags
Array of strings
object
contentType
string
forwardRef
string or null
body
string
path
string or null
exact
boolean
lastPublishedDate
integer or null <timestamp>

Responses

Request samples

Content type
application/json
{
  • "_id": "page-weather-home",
  • "_tenant": "default",
  • "name": "Weather home"
}

Response samples

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

update a cms page with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the cms page or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

delete a cms page

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

replace every cms page of the tenant with the given files

Request Body schema: application/json
required

the cms files, as sent by the CLI

Array
name
required
string
content
required
string
metadata
object
object or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

keyring

read all keyrings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a keyring; apiKey, integrationToken and bearerToken are stored as written in the body, Daikoku generates nothing

Request Body schema: application/json
required

the keyring to create

_id
required
string
_tenant
required
string
team
required
string
customName
string
required
object (OtoroshiApiKey)

OtoroshiApiKey

required
object
createdAt
required
integer <timestamp>
ApiSubscriptionRotation (object) or null
integrationToken
required
string
bearerToken
string or null
ThirdPartySubscriptionInformations.Stripe (object)
enabled
boolean
object

Responses

Request samples

Content type
application/json
{
  • "_id": "keyring-weather",
  • "_tenant": "default",
  • "team": "team-weather",
  • "otoroshiSettings": {
    },
  • "apiKey": {
    },
  • "integrationToken": "weather-mobile-app-integration-token",
  • "createdAt": 1759190400000
}

Response samples

Content type
application/json
{
  • "_id": "keyring-weather",
  • "_tenant": "default",
  • "team": "team-weather",
  • "otoroshiSettings": {
    },
  • "apiKey": {
    },
  • "integrationToken": "weather-mobile-app-integration-token",
  • "createdAt": 1759190400000
}

read a keyring

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "keyring-weather",
  • "_tenant": "default",
  • "team": "team-weather",
  • "otoroshiSettings": {
    },
  • "apiKey": {
    },
  • "integrationToken": "weather-mobile-app-integration-token",
  • "createdAt": 1759190400000
}

update a keyring; its secrets, createdAt, rotation and payment information are kept

path Parameters
id
required
string
Request Body schema: application/json
required

the keyring to update

_id
required
string
_tenant
required
string
team
required
string
customName
string
required
object (OtoroshiApiKey)

OtoroshiApiKey

required
object
createdAt
required
integer <timestamp>
ApiSubscriptionRotation (object) or null
integrationToken
required
string
bearerToken
string or null
ThirdPartySubscriptionInformations.Stripe (object)
enabled
boolean
object

Responses

Request samples

Content type
application/json
{
  • "_id": "keyring-weather",
  • "_tenant": "default",
  • "team": "team-weather",
  • "otoroshiSettings": {
    },
  • "apiKey": {
    },
  • "integrationToken": "weather-mobile-app-integration-token",
  • "createdAt": 1759190400000
}

Response samples

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

update a keyring with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the keyring or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

delete a keyring with its subscriptions and its Otoroshi api key

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

remote-catalog

read all remote catalogs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a remote catalog

Request Body schema: application/json
required

the remote catalog to create

_id
required
string
_tenant
required
string
name
required
string
enabled
boolean
object
object
allowedKinds
Array of strings
Items Enum: "team" "usage-plan" "api" "keyring" "api-subscription" "cms-page" "api-documentation-page"
maxDeletionPercent
integer <int32>
adoptExisting
boolean
folderPerTeam
boolean

GitHub and GitLab only. Each teams// folder may only declare the entities of that team; everything outside teams/ is tenant level

allowDeletions
boolean
Default: true

when false, an entity removed from the source is detached (it loses its catalog tag) instead of being deleted

Responses

Request samples

Content type
application/json
{
  • "_id": "catalog-weather",
  • "_tenant": "default",
  • "name": "Weather catalog"
}

Response samples

Content type
application/json
{
  • "_id": "catalog-weather",
  • "_tenant": "default",
  • "name": "Weather catalog"
}

export the tenant as a catalog, a zip with one folder per kind and one YAML file per entity; the files hold the credentials as stored, keep them somewhere safe

query Parameters
all
boolean
Default: false

also export the entities already managed by a catalog (tagged created_by)

Responses

Response samples

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

read a remote catalog

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "catalog-weather",
  • "_tenant": "default",
  • "name": "Weather catalog"
}

update a remote catalog

path Parameters
id
required
string
Request Body schema: application/json
required

the remote catalog to update

_id
required
string
_tenant
required
string
name
required
string
enabled
boolean
object
object
allowedKinds
Array of strings
Items Enum: "team" "usage-plan" "api" "keyring" "api-subscription" "cms-page" "api-documentation-page"
maxDeletionPercent
integer <int32>
adoptExisting
boolean
folderPerTeam
boolean

GitHub and GitLab only. Each teams// folder may only declare the entities of that team; everything outside teams/ is tenant level

allowDeletions
boolean
Default: true

when false, an entity removed from the source is detached (it loses its catalog tag) instead of being deleted

Responses

Request samples

Content type
application/json
{
  • "_id": "catalog-weather",
  • "_tenant": "default",
  • "name": "Weather catalog"
}

Response samples

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

update a remote catalog with JSON patch or by merging JSON object

path Parameters
id
required
string
Request Body schema: application/json
required

the patch to update the remote catalog or a JSON object

One of
Array
op
required
string
Enum: "add" "replace" "remove" "copy" "test"
path
required
string
value
any

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

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

delete a remote catalog; the entities it deployed stay, detached (their created_by tag is removed). Undeploy first to delete them

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "done": true
}

check a whole catalog sent in the request, without fetching nor writing anything

path Parameters
id
required
string
Request Body schema:
required

every file of the catalog, as an array of files or as a zip of the catalog root whose .json, .yaml and .yml files are read; at most 20 MB, and 100 MB once unzipped

Array
path
required
string
content
required
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "catalog": "string",
  • "at": 0,
  • "status": "completed",
  • "created": [
    ],
  • "updated": [
    ],
  • "deleted": [
    ],
  • "detached": [
    ],
  • "errors": [
    ]
}

dry run - fetch the configured source and report what a deploy would do, without writing anything

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "catalog": "string",
  • "at": 0,
  • "status": "completed",
  • "created": [
    ],
  • "updated": [
    ],
  • "deleted": [
    ],
  • "detached": [
    ],
  • "errors": [
    ]
}

deploy the catalog - validate everything, then write; nothing is applied when validation fails

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "catalog": "string",
  • "at": 0,
  • "status": "completed",
  • "created": [
    ],
  • "updated": [
    ],
  • "deleted": [
    ],
  • "detached": [
    ],
  • "errors": [
    ]
}

delete every entity this catalog deployed; the catalog itself is kept

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_tenant": "string",
  • "catalog": "string",
  • "at": 0,
  • "status": "completed",
  • "created": [
    ],
  • "updated": [
    ],
  • "deleted": [
    ],
  • "detached": [
    ],
  • "errors": [
    ]
}

state

export the whole database as a stream, one entity per line

query Parameters
export-audit-trail
boolean

also export the audit trail

download
boolean

answer with a Content-Disposition header, to download a file

Responses

Response samples

Content type
application/x-ndjson
"string"

replace the whole database with an export - every table is emptied first

Request Body schema: application/x-ndjson
required

an export, one {type, payload} JSON object per line

string

Responses

Request samples

Content type
application/x-ndjson
"string"

Response samples

Content type
application/json
{
  • "done": true
}

empty the database and initialise it again - only available in dev and test modes

query Parameters
path
string

file to initialise the database from

Responses

Response samples

Content type
application/json
{
  • "done": true
}