Daikoku Admin API (16.3.0)

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

200
401
404

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

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

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
_deleted	boolean or null
name required	string
domain	string or null
contact required	string
	object (DaikokuStyle) DaikokuStyle
defaultLanguage	string or null
	Array of objects or null (OtoroshiSettings)
	(MailerSettings.ConsoleMailerSettings (object or null)) or (MailerSettings.MailgunSettings (object or null)) or (MailerSettings.MailjetSettings (object or null)) or (MailerSettings.SimpleSMTPSettings (object or null)) or (MailerSettings.SendgridSettings (object or null))
	object (S3Configuration) S3Configuration
authProvider	string or null Enum: "local" "otoroshi" "ldap" "oauth2"
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"
aggregationApiKeysSecurity	boolean or null
robotTxt	string or null
	Array of ThirdPartyPaymentSettings.StripeSettings (object) or null
display	string or null Enum: "default" "environment"
environments	Array of strings or null

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"enabled": true,
"_deleted": true,
"name": "string",
"domain": "string",
"contact": "string",
"style": {"js": "string",
"css": "string",
"colorTheme": "string",
"jsUrl": "string",
"cssUrl": "string",
"faviconUrl": "string",
"fontFamilyUrl": "string",
"title": "string",
"description": "string",
"unloggedHome": "string",
"homePageVisible": true,
"homeCmsPage": "string",
"notFoundCmsPage": "string",
"authenticatedCmsPage": "string",
"logo": "string",
"footer": "string"
},
"defaultLanguage": "string",
"otoroshiSettings": [{"id": "string",
"url": "string",
"host": "string",
"clientId": "string",
"clientSecret": "string"
}
],
"mailerSettings": {"type": "console",
"template": "string"
},
"bucketSettings": {"bucket": "string",
"endpoint": "string",
"region": "string",
"access": "string",
"secret": "string",
"chunkSize": 0,
"v4auth": true
},
"authProvider": "local",
"authProviderSettings": { },
"auditTrailConfig": {"elasticConfigs": {"clusterUri": "string",
"index": "string",
"type": "string",
"user": "string",
"password": "string",
"headers": { }
},
"auditWebhooks": [{"url": "string",
"headers": { }
}
],
"alertsEmails": ["string"
],
"kafkaConfig": {"servers": ["string"
],
"keyPass": "string",
"keystore": "string",
"truststore": "string",
"auditTopic": "string",
"hostValidation": true
}
},
"isPrivate": true,
"adminApi": "string",
"adminSubscriptions": ["string"
],
"creationSecurity": true,
"subscriptionSecurity": true,
"apiReferenceHideForGuest": true,
"defaultMessage": "string",
"tenantMode": "default",
"aggregationApiKeysSecurity": true,
"robotTxt": "string",
"thirdPartyPaymentSettings": [{"_id": "string",
"name": "string",
"publicKey": "string",
"secretKey": "string"
}
],
"display": "default",
"environments": ["string"
]
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a tenant

path Parameters

id

required

string

The ID of the tenant to retrieve

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all tenant

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"enabled": true,
"_deleted": true,
"name": "string",
"domain": "string",
"contact": "string",
"style": {"js": "string",
"css": "string",
"colorTheme": "string",
"jsUrl": "string",
"cssUrl": "string",
"faviconUrl": "string",
"fontFamilyUrl": "string",
"title": "string",
"description": "string",
"unloggedHome": "string",
"homePageVisible": true,
"homeCmsPage": "string",
"notFoundCmsPage": "string",
"authenticatedCmsPage": "string",
"logo": "string",
"footer": "string"
},
"defaultLanguage": "string",
"otoroshiSettings": [{"id": "string",
"url": "string",
"host": "string",
"clientId": "string",
"clientSecret": "string"
}
],
"mailerSettings": {"type": "console",
"template": "string"
},
"bucketSettings": {"bucket": "string",
"endpoint": "string",
"region": "string",
"access": "string",
"secret": "string",
"chunkSize": 0,
"v4auth": true
},
"authProvider": "local",
"authProviderSettings": { },
"auditTrailConfig": {"elasticConfigs": {"clusterUri": "string",
"index": "string",
"type": "string",
"user": "string",
"password": "string",
"headers": { }
},
"auditWebhooks": [{"url": "string",
"headers": { }
}
],
"alertsEmails": ["string"
],
"kafkaConfig": {"servers": ["string"
],
"keyPass": "string",
"keystore": "string",
"truststore": "string",
"auditTopic": "string",
"hostValidation": true
}
},
"isPrivate": true,
"adminApi": "string",
"adminSubscriptions": ["string"
],
"creationSecurity": true,
"subscriptionSecurity": true,
"apiReferenceHideForGuest": true,
"defaultMessage": "string",
"tenantMode": "default",
"aggregationApiKeysSecurity": true,
"robotTxt": "string",
"thirdPartyPaymentSettings": [{"_id": "string",
"name": "string",
"publicKey": "string",
"secretKey": "string"
}
],
"display": "default",
"environments": ["string"
]
}
]

create a tenant

Request Body schema: application/json
required

the tenant to create

_id required	string
enabled required	boolean
_deleted	boolean or null
name required	string
domain	string or null
contact required	string
	object (DaikokuStyle) DaikokuStyle
defaultLanguage	string or null
	Array of objects or null (OtoroshiSettings)
	(MailerSettings.ConsoleMailerSettings (object or null)) or (MailerSettings.MailgunSettings (object or null)) or (MailerSettings.MailjetSettings (object or null)) or (MailerSettings.SimpleSMTPSettings (object or null)) or (MailerSettings.SendgridSettings (object or null))
	object (S3Configuration) S3Configuration
authProvider	string or null Enum: "local" "otoroshi" "ldap" "oauth2"
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"
aggregationApiKeysSecurity	boolean or null
robotTxt	string or null
	Array of ThirdPartyPaymentSettings.StripeSettings (object) or null
display	string or null Enum: "default" "environment"
environments	Array of strings or null

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"enabled": true,
"_deleted": true,
"name": "string",
"domain": "string",
"contact": "string",
"style": {"js": "string",
"css": "string",
"colorTheme": "string",
"jsUrl": "string",
"cssUrl": "string",
"faviconUrl": "string",
"fontFamilyUrl": "string",
"title": "string",
"description": "string",
"unloggedHome": "string",
"homePageVisible": true,
"homeCmsPage": "string",
"notFoundCmsPage": "string",
"authenticatedCmsPage": "string",
"logo": "string",
"footer": "string"
},
"defaultLanguage": "string",
"otoroshiSettings": [{"id": "string",
"url": "string",
"host": "string",
"clientId": "string",
"clientSecret": "string"
}
],
"mailerSettings": {"type": "console",
"template": "string"
},
"bucketSettings": {"bucket": "string",
"endpoint": "string",
"region": "string",
"access": "string",
"secret": "string",
"chunkSize": 0,
"v4auth": true
},
"authProvider": "local",
"authProviderSettings": { },
"auditTrailConfig": {"elasticConfigs": {"clusterUri": "string",
"index": "string",
"type": "string",
"user": "string",
"password": "string",
"headers": { }
},
"auditWebhooks": [{"url": "string",
"headers": { }
}
],
"alertsEmails": ["string"
],
"kafkaConfig": {"servers": ["string"
],
"keyPass": "string",
"keystore": "string",
"truststore": "string",
"auditTopic": "string",
"hostValidation": true
}
},
"isPrivate": true,
"adminApi": "string",
"adminSubscriptions": ["string"
],
"creationSecurity": true,
"subscriptionSecurity": true,
"apiReferenceHideForGuest": true,
"defaultMessage": "string",
"tenantMode": "default",
"aggregationApiKeysSecurity": true,
"robotTxt": "string",
"thirdPartyPaymentSettings": [{"_id": "string",
"name": "string",
"publicKey": "string",
"secretKey": "string"
}
],
"display": "default",
"environments": ["string"
]
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"enabled": true,
"_deleted": true,
"name": "string",
"domain": "string",
"contact": "string",
"style": {"js": "string",
"css": "string",
"colorTheme": "string",
"jsUrl": "string",
"cssUrl": "string",
"faviconUrl": "string",
"fontFamilyUrl": "string",
"title": "string",
"description": "string",
"unloggedHome": "string",
"homePageVisible": true,
"homeCmsPage": "string",
"notFoundCmsPage": "string",
"authenticatedCmsPage": "string",
"logo": "string",
"footer": "string"
},
"defaultLanguage": "string",
"otoroshiSettings": [{"id": "string",
"url": "string",
"host": "string",
"clientId": "string",
"clientSecret": "string"
}
],
"mailerSettings": {"type": "console",
"template": "string"
},
"bucketSettings": {"bucket": "string",
"endpoint": "string",
"region": "string",
"access": "string",
"secret": "string",
"chunkSize": 0,
"v4auth": true
},
"authProvider": "local",
"authProviderSettings": { },
"auditTrailConfig": {"elasticConfigs": {"clusterUri": "string",
"index": "string",
"type": "string",
"user": "string",
"password": "string",
"headers": { }
},
"auditWebhooks": [{"url": "string",
"headers": { }
}
],
"alertsEmails": ["string"
],
"kafkaConfig": {"servers": ["string"
],
"keyPass": "string",
"keystore": "string",
"truststore": "string",
"auditTopic": "string",
"hostValidation": true
}
},
"isPrivate": true,
"adminApi": "string",
"adminSubscriptions": ["string"
],
"creationSecurity": true,
"subscriptionSecurity": true,
"apiReferenceHideForGuest": true,
"defaultMessage": "string",
"tenantMode": "default",
"aggregationApiKeysSecurity": true,
"robotTxt": "string",
"thirdPartyPaymentSettings": [{"_id": "string",
"name": "string",
"publicKey": "string",
"secretKey": "string"
}
],
"display": "default",
"environments": ["string"
]
}

user

delete a user

path Parameters

id

required

string

Responses

Response samples

200
401
404

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

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

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
_deleted	boolean
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
personalToken	string 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
	object (TwoFactorAuthentication) TwoFactorAuthentication
	object (UserInvitation) UserInvitation

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_deleted": true,
"tenants": ["string"
],
"origins": ["local"
],
"name": "string",
"email": "string",
"picture": "string",
"pictureFromProvider": true,
"personalToken": "string",
"isDaikokuAdmin": true,
"password": "string",
"hardwareKeyRegistrations": [{ }
],
"lastTenant": "string",
"metadata": { },
"defaultLanguage": "string",
"starredApis": ["string"
],
"twoFactorAuthentication": {"enabled": true,
"secret": "string",
"token": "string",
"backupCodes": "string"
},
"invitation": {"token": "string",
"createdAt": 0,
"team": "string",
"notificationId": "string",
"registered": true
}
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a user

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all user

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_deleted": true,
"tenants": ["string"
],
"origins": ["local"
],
"name": "string",
"email": "string",
"picture": "string",
"pictureFromProvider": true,
"personalToken": "string",
"isDaikokuAdmin": true,
"password": "string",
"hardwareKeyRegistrations": [{ }
],
"lastTenant": "string",
"metadata": { },
"defaultLanguage": "string",
"starredApis": ["string"
],
"twoFactorAuthentication": {"enabled": true,
"secret": "string",
"token": "string",
"backupCodes": "string"
},
"invitation": {"token": "string",
"createdAt": 0,
"team": "string",
"notificationId": "string",
"registered": true
}
}
]

creates a user

Request Body schema: application/json
required

the user to create

_id required	string
_deleted	boolean
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
personalToken	string 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
	object (TwoFactorAuthentication) TwoFactorAuthentication
	object (UserInvitation) UserInvitation

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_deleted": true,
"tenants": ["string"
],
"origins": ["local"
],
"name": "string",
"email": "string",
"picture": "string",
"pictureFromProvider": true,
"personalToken": "string",
"isDaikokuAdmin": true,
"password": "string",
"hardwareKeyRegistrations": [{ }
],
"lastTenant": "string",
"metadata": { },
"defaultLanguage": "string",
"starredApis": ["string"
],
"twoFactorAuthentication": {"enabled": true,
"secret": "string",
"token": "string",
"backupCodes": "string"
},
"invitation": {"token": "string",
"createdAt": 0,
"team": "string",
"notificationId": "string",
"registered": true
}
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"_deleted": true,
"tenants": ["string"
],
"origins": ["local"
],
"name": "string",
"email": "string",
"picture": "string",
"pictureFromProvider": true,
"personalToken": "string",
"isDaikokuAdmin": true,
"password": "string",
"hardwareKeyRegistrations": [{ }
],
"lastTenant": "string",
"metadata": { },
"defaultLanguage": "string",
"starredApis": ["string"
],
"twoFactorAuthentication": {"enabled": true,
"secret": "string",
"token": "string",
"backupCodes": "string"
},
"invitation": {"token": "string",
"createdAt": 0,
"team": "string",
"notificationId": "string",
"registered": true
}
}

team

delete a team

path Parameters

id

required

string

Responses

Response samples

200
401
404

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

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

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
_tenant required	string
_deleted	boolean or null
type required	string Enum: "Personal" "Organization" "Admin"
name	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

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"type": "Personal",
"name": "string",
"description": "string",
"contact": "string",
"avatar": "string",
"users": [{"userId": "string",
"teamPermission": "Administrator"
}
],
"authorizedEntities": [{"otoroshiSettingsId": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
}
}
],
"apiKeyVisibility": "administrator",
"metadata": { },
"apisCreationPermission": true,
"verified": true
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a team

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all team

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"_deleted": true,
"type": "Personal",
"name": "string",
"description": "string",
"contact": "string",
"avatar": "string",
"users": [{"userId": "string",
"teamPermission": "Administrator"
}
],
"authorizedEntities": [{"otoroshiSettingsId": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
}
}
],
"apiKeyVisibility": "administrator",
"metadata": { },
"apisCreationPermission": true,
"verified": true
}
]

creates a team

Request Body schema: application/json
required

the team to create

_id required	string
_tenant required	string
_deleted	boolean or null
type required	string Enum: "Personal" "Organization" "Admin"
name	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

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"type": "Personal",
"name": "string",
"description": "string",
"contact": "string",
"avatar": "string",
"users": [{"userId": "string",
"teamPermission": "Administrator"
}
],
"authorizedEntities": [{"otoroshiSettingsId": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
}
}
],
"apiKeyVisibility": "administrator",
"metadata": { },
"apisCreationPermission": true,
"verified": true
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"type": "Personal",
"name": "string",
"description": "string",
"contact": "string",
"avatar": "string",
"users": [{"userId": "string",
"teamPermission": "Administrator"
}
],
"authorizedEntities": [{"otoroshiSettingsId": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
}
}
],
"apiKeyVisibility": "administrator",
"metadata": { },
"apisCreationPermission": true,
"verified": true
}

api

delete a api

path Parameters

id

required

string

Responses

Response samples

200
401
404

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

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

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
_tenant required	string
_deleted	boolean or null
team required	string
name required	string
lastUpdate required	integer <timestamp>
description	string or null
smallDescription	string or null
header	string or null
image	string or null
currentVersion required	string
supportedVersions	Array of strings
isDefault	boolean or null
	object (Testing) Testing
required	object (ApiDocumentation) ApiDocumentation
	object (SwaggerAccess) SwaggerAccess
tags	Array of strings or null
categories	Array of strings or null
visibility required	string Enum: "Public" "Private" "PublicWithAuthorizations" "AdminOnly"
possibleUsagePlans required	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
apis	Array of strings
state required	string Enum: "created" "published" "blocked" "deprecated"

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"name": "string",
"lastUpdate": 0,
"description": "string",
"smallDescription": "string",
"header": "string",
"image": "string",
"currentVersion": "string",
"supportedVersions": ["string"
],
"isDefault": true,
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"tags": ["string"
],
"categories": ["string"
],
"visibility": "Public",
"possibleUsagePlans": ["string"
],
"defaultUsagePlan": "string",
"authorizedTeams": ["string"
],
"posts": ["string"
],
"issues": ["string"
],
"issuesTags": [{"id": "string",
"name": "string",
"color": "string"
}
],
"stars": 0,
"parent": "string",
"apis": ["string"
],
"state": "created"
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a api

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all api

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"name": "string",
"lastUpdate": 0,
"description": "string",
"smallDescription": "string",
"header": "string",
"image": "string",
"currentVersion": "string",
"supportedVersions": ["string"
],
"isDefault": true,
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"tags": ["string"
],
"categories": ["string"
],
"visibility": "Public",
"possibleUsagePlans": ["string"
],
"defaultUsagePlan": "string",
"authorizedTeams": ["string"
],
"posts": ["string"
],
"issues": ["string"
],
"issuesTags": [{"id": "string",
"name": "string",
"color": "string"
}
],
"stars": 0,
"parent": "string",
"apis": ["string"
],
"state": "created"
}
]

creates a api

Request Body schema: application/json
required

the api to create

_id required	string
_tenant required	string
_deleted	boolean or null
team required	string
name required	string
lastUpdate required	integer <timestamp>
description	string or null
smallDescription	string or null
header	string or null
image	string or null
currentVersion required	string
supportedVersions	Array of strings
isDefault	boolean or null
	object (Testing) Testing
required	object (ApiDocumentation) ApiDocumentation
	object (SwaggerAccess) SwaggerAccess
tags	Array of strings or null
categories	Array of strings or null
visibility required	string Enum: "Public" "Private" "PublicWithAuthorizations" "AdminOnly"
possibleUsagePlans required	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
apis	Array of strings
state required	string Enum: "created" "published" "blocked" "deprecated"

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"name": "string",
"lastUpdate": 0,
"description": "string",
"smallDescription": "string",
"header": "string",
"image": "string",
"currentVersion": "string",
"supportedVersions": ["string"
],
"isDefault": true,
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"tags": ["string"
],
"categories": ["string"
],
"visibility": "Public",
"possibleUsagePlans": ["string"
],
"defaultUsagePlan": "string",
"authorizedTeams": ["string"
],
"posts": ["string"
],
"issues": ["string"
],
"issuesTags": [{"id": "string",
"name": "string",
"color": "string"
}
],
"stars": 0,
"parent": "string",
"apis": ["string"
],
"state": "created"
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"name": "string",
"lastUpdate": 0,
"description": "string",
"smallDescription": "string",
"header": "string",
"image": "string",
"currentVersion": "string",
"supportedVersions": ["string"
],
"isDefault": true,
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"tags": ["string"
],
"categories": ["string"
],
"visibility": "Public",
"possibleUsagePlans": ["string"
],
"defaultUsagePlan": "string",
"authorizedTeams": ["string"
],
"posts": ["string"
],
"issues": ["string"
],
"issuesTags": [{"id": "string",
"name": "string",
"color": "string"
}
],
"stars": 0,
"parent": "string",
"apis": ["string"
],
"state": "created"
}

api-subscription

delete a api-subscription

path Parameters

id

required

string

Responses

Response samples

200
401
404

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

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

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
_deleted	boolean or null
required	object (OtoroshiApiKey) OtoroshiApiKey
plan required	string
team required	string
api required	string
createdAt required	integer <timestamp>
by required	string
customName	string or null
adminCustomName	string or null
enabled	boolean or null
	object (ApiSubscriptionRotation) ApiSubscriptionRotation
integrationToken required	string
customMetadata	object
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
parent	string or null
	ThirdPartySubscriptionInformations.Stripe (object)

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"apiKey": {"clientName": "string",
"clientId": "string",
"clientSecret": "string"
},
"plan": "string",
"team": "string",
"api": "string",
"createdAt": 0,
"by": "string",
"customName": "string",
"adminCustomName": "string",
"enabled": true,
"rotation": {"enabled": true,
"rotationEvery": 0,
"gracePeriod": 0,
"pendingRotation": true
},
"integrationToken": "string",
"customMetadata": { },
"metadata": { },
"tags": ["string"
],
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true,
"parent": "string",
"thirdPartySubscriptionInformations": {"subscriptionId": "string",
"primaryElementId": "string",
"meteredElementId": "string"
}
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a api-subscription

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all api-subscription

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"_deleted": true,
"apiKey": {"clientName": "string",
"clientId": "string",
"clientSecret": "string"
},
"plan": "string",
"team": "string",
"api": "string",
"createdAt": 0,
"by": "string",
"customName": "string",
"adminCustomName": "string",
"enabled": true,
"rotation": {"enabled": true,
"rotationEvery": 0,
"gracePeriod": 0,
"pendingRotation": true
},
"integrationToken": "string",
"customMetadata": { },
"metadata": { },
"tags": ["string"
],
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true,
"parent": "string",
"thirdPartySubscriptionInformations": {"subscriptionId": "string",
"primaryElementId": "string",
"meteredElementId": "string"
}
}
]

creates a api-subscription

Request Body schema: application/json
required

the api-subscription to create

_id required	string
_tenant required	string
_deleted	boolean or null
required	object (OtoroshiApiKey) OtoroshiApiKey
plan required	string
team required	string
api required	string
createdAt required	integer <timestamp>
by required	string
customName	string or null
adminCustomName	string or null
enabled	boolean or null
	object (ApiSubscriptionRotation) ApiSubscriptionRotation
integrationToken required	string
customMetadata	object
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
parent	string or null
	ThirdPartySubscriptionInformations.Stripe (object)

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"apiKey": {"clientName": "string",
"clientId": "string",
"clientSecret": "string"
},
"plan": "string",
"team": "string",
"api": "string",
"createdAt": 0,
"by": "string",
"customName": "string",
"adminCustomName": "string",
"enabled": true,
"rotation": {"enabled": true,
"rotationEvery": 0,
"gracePeriod": 0,
"pendingRotation": true
},
"integrationToken": "string",
"customMetadata": { },
"metadata": { },
"tags": ["string"
],
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true,
"parent": "string",
"thirdPartySubscriptionInformations": {"subscriptionId": "string",
"primaryElementId": "string",
"meteredElementId": "string"
}
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"apiKey": {"clientName": "string",
"clientId": "string",
"clientSecret": "string"
},
"plan": "string",
"team": "string",
"api": "string",
"createdAt": 0,
"by": "string",
"customName": "string",
"adminCustomName": "string",
"enabled": true,
"rotation": {"enabled": true,
"rotationEvery": 0,
"gracePeriod": 0,
"pendingRotation": true
},
"integrationToken": "string",
"customMetadata": { },
"metadata": { },
"tags": ["string"
],
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true,
"parent": "string",
"thirdPartySubscriptionInformations": {"subscriptionId": "string",
"primaryElementId": "string",
"meteredElementId": "string"
}
}

api-documentation-page

delete a api-documentation-page

path Parameters

id

required

string

Responses

Response samples

200
401
404

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

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

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
_deleted	boolean or null
title required	string
lastModificationAt required	integer <timestamp>
content	string or null
contentType	string or null
remoteContentEnabled	boolean or null
remoteContentUrl	string or null
remoteContentHeaders	object or null

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"title": "string",
"lastModificationAt": 0,
"content": "string",
"contentType": "string",
"remoteContentEnabled": true,
"remoteContentUrl": "string",
"remoteContentHeaders": { }
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a api-documentation-page

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all api-documentation-page

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"_deleted": true,
"title": "string",
"lastModificationAt": 0,
"content": "string",
"contentType": "string",
"remoteContentEnabled": true,
"remoteContentUrl": "string",
"remoteContentHeaders": { }
}
]

creates a api-documentation-page

Request Body schema: application/json
required

the api-documentation-page to create

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

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"title": "string",
"lastModificationAt": 0,
"content": "string",
"contentType": "string",
"remoteContentEnabled": true,
"remoteContentUrl": "string",
"remoteContentHeaders": { }
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"title": "string",
"lastModificationAt": 0,
"content": "string",
"contentType": "string",
"remoteContentEnabled": true,
"remoteContentUrl": "string",
"remoteContentHeaders": { }
}

notification

delete a notification

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"done": true
}

update a notification with JSON patch or by merging JSON object

path Parameters

id

required

string

Request Body schema: application/json
required

the patch to update the notification or a JSON object

One of

Array

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

Responses

Request samples

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

Content type

application/json

{"error": "string"
}

update a notification

path Parameters

id

required

string

Request Body schema: application/json
required

the notification to update

_id required	string
_tenant required	string
_deleted	boolean or null
team	string
required	object (NotificationSender) NotificationSender
date	integer or null <timestamp>
notificationType	string Enum: "AcceptOrReject" "AcceptOnly"
required	NotificationStatus.Accepted (object) or NotificationStatus.Rejected (object) or NotificationStatus.Pending (object)
required	NotificationAction.ApiAccess (object) or NotificationAction.TeamAccess (object) or NotificationAction.ApiSubscription (object) or NotificationAction.ApiSubscriptionReject (object) or NotificationAction.ApiSubscriptionAccept (object) or NotificationAction.OtoroshiSyncSubscriptionError (object) or NotificationAction.OtoroshiSyncApiError (object) or NotificationAction.ApiKeyDeletionInformation (object) or NotificationAction.ApiKeyRotationInProgress (object) or NotificationAction.ApiKeyRotationEnded (object) or NotificationAction.TeamInvitation (object) or NotificationAction.ApiKeyRefresh (object) or NotificationAction.NewPostPublished (object) or NotificationAction.NewIssueOpen (object) or NotificationAction.NewCommentOnIssue (object) or NotificationAction.TransferApiOwnership (object) or NotificationAction.CheckoutForSubscription (object)

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"sender": {"name": "string",
"email": "string",
"id": "string"
},
"date": 0,
"notificationType": "AcceptOrReject",
"status": {"status": "Accepted",
"date": 0
},
"action": {"api": "string",
"team": "string"
}
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a notification

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all notification

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"sender": {"name": "string",
"email": "string",
"id": "string"
},
"date": 0,
"notificationType": "AcceptOrReject",
"status": {"status": "Accepted",
"date": 0
},
"action": {"api": "string",
"team": "string"
}
}
]

creates a notification

Request Body schema: application/json
required

the notification to create

_id required	string
_tenant required	string
_deleted	boolean or null
team	string
required	object (NotificationSender) NotificationSender
date	integer or null <timestamp>
notificationType	string Enum: "AcceptOrReject" "AcceptOnly"
required	NotificationStatus.Accepted (object) or NotificationStatus.Rejected (object) or NotificationStatus.Pending (object)
required	NotificationAction.ApiAccess (object) or NotificationAction.TeamAccess (object) or NotificationAction.ApiSubscription (object) or NotificationAction.ApiSubscriptionReject (object) or NotificationAction.ApiSubscriptionAccept (object) or NotificationAction.OtoroshiSyncSubscriptionError (object) or NotificationAction.OtoroshiSyncApiError (object) or NotificationAction.ApiKeyDeletionInformation (object) or NotificationAction.ApiKeyRotationInProgress (object) or NotificationAction.ApiKeyRotationEnded (object) or NotificationAction.TeamInvitation (object) or NotificationAction.ApiKeyRefresh (object) or NotificationAction.NewPostPublished (object) or NotificationAction.NewIssueOpen (object) or NotificationAction.NewCommentOnIssue (object) or NotificationAction.TransferApiOwnership (object) or NotificationAction.CheckoutForSubscription (object)

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"sender": {"name": "string",
"email": "string",
"id": "string"
},
"date": 0,
"notificationType": "AcceptOrReject",
"status": {"status": "Accepted",
"date": 0
},
"action": {"api": "string",
"team": "string"
}
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"sender": {"name": "string",
"email": "string",
"id": "string"
},
"date": 0,
"notificationType": "AcceptOrReject",
"status": {"status": "Accepted",
"date": 0
},
"action": {"api": "string",
"team": "string"
}
}

user-session

delete a user-session

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"done": true
}

update a user-session 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-session or a JSON object

One of

Array

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

Responses

Request samples

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

Content type

application/json

{"error": "string"
}

update a user-session

path Parameters

id

required

string

Request Body schema: application/json
required

the user-session to update

_id required	string
sessionId required	string
userId required	string
userName required	string
userEmail required	string
impersonatorId	string or null
impersonatorName	string or null
impersonatorEmail	string or null
impersonatorSessionId	string or null
created	integer or null <timestamp>
ttl	integer or null <int64>
expires	integer or null <timestamp>

Responses

Request samples

Payload

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
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a user-session

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all user-session

Responses

Response samples

200
401

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
}
]

creates a user-session

Request Body schema: application/json
required

the user-session to create

_id required	string
sessionId required	string
userId required	string
userName required	string
userEmail required	string
impersonatorId	string or null
impersonatorName	string or null
impersonatorEmail	string or null
impersonatorSessionId	string or null
created	integer or null <timestamp>
ttl	integer or null <int64>
expires	integer or null <timestamp>

Responses

Request samples

Payload

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
}

Response samples

201
400
401

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
}

api-key-consumption

delete a api-key-consumption

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"done": true
}

update a api-key-consumption 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-key-consumption or a JSON object

One of

Array

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

Responses

Request samples

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

Content type

application/json

{"error": "string"
}

update a api-key-consumption

path Parameters

id

required

string

Request Body schema: application/json
required

the api-key-consumption to update

_id required	string
_deleted	boolean or null
_tenant required	string
team required	string
api required	string
plan required	string
clientId required	string
hits required	integer <int32>
required	object (ApiKeyGlobalConsumptionInformations) ApiKeyGlobalConsumptionInformations
required	object (ApiKeyQuotas) ApiKeyQuotas
required	object (ApiKeyBilling) ApiKeyBilling
from required	integer <timestamp>
to required	integer <timestamp>
state required	string Enum: "completed" "inProgress"

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_deleted": true,
"_tenant": "string",
"team": "string",
"api": "string",
"plan": "string",
"clientId": "string",
"hits": 0,
"globalInformations": {"hits": 0,
"dataIn": 0,
"dataOut": 0,
"avgDuration": 0,
"avgOverhead": 0
},
"quotas": {"authorizedCallsPerSec": 0,
"currentCallsPerSec": 0,
"remainingCallsPerSec": 0,
"authorizedCallsPerDay": 0,
"currentCallsPerDay": 0,
"remainingCallsPerDay": 0,
"authorizedCallsPerMonth": 0,
"currentCallsPerMonth": 0,
"remainingCallsPerMonth": 0
},
"billing": {"hits": 0,
"total": 0
},
"from": 0,
"to": 0,
"state": "completed"
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a api-key-consumption

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all api-key-consumption

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_deleted": true,
"_tenant": "string",
"team": "string",
"api": "string",
"plan": "string",
"clientId": "string",
"hits": 0,
"globalInformations": {"hits": 0,
"dataIn": 0,
"dataOut": 0,
"avgDuration": 0,
"avgOverhead": 0
},
"quotas": {"authorizedCallsPerSec": 0,
"currentCallsPerSec": 0,
"remainingCallsPerSec": 0,
"authorizedCallsPerDay": 0,
"currentCallsPerDay": 0,
"remainingCallsPerDay": 0,
"authorizedCallsPerMonth": 0,
"currentCallsPerMonth": 0,
"remainingCallsPerMonth": 0
},
"billing": {"hits": 0,
"total": 0
},
"from": 0,
"to": 0,
"state": "completed"
}
]

creates a api-key-consumption

Request Body schema: application/json
required

the api-key-consumption to create

_id required	string
_deleted	boolean or null
_tenant required	string
team required	string
api required	string
plan required	string
clientId required	string
hits required	integer <int32>
required	object (ApiKeyGlobalConsumptionInformations) ApiKeyGlobalConsumptionInformations
required	object (ApiKeyQuotas) ApiKeyQuotas
required	object (ApiKeyBilling) ApiKeyBilling
from required	integer <timestamp>
to required	integer <timestamp>
state required	string Enum: "completed" "inProgress"

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_deleted": true,
"_tenant": "string",
"team": "string",
"api": "string",
"plan": "string",
"clientId": "string",
"hits": 0,
"globalInformations": {"hits": 0,
"dataIn": 0,
"dataOut": 0,
"avgDuration": 0,
"avgOverhead": 0
},
"quotas": {"authorizedCallsPerSec": 0,
"currentCallsPerSec": 0,
"remainingCallsPerSec": 0,
"authorizedCallsPerDay": 0,
"currentCallsPerDay": 0,
"remainingCallsPerDay": 0,
"authorizedCallsPerMonth": 0,
"currentCallsPerMonth": 0,
"remainingCallsPerMonth": 0
},
"billing": {"hits": 0,
"total": 0
},
"from": 0,
"to": 0,
"state": "completed"
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"_deleted": true,
"_tenant": "string",
"team": "string",
"api": "string",
"plan": "string",
"clientId": "string",
"hits": 0,
"globalInformations": {"hits": 0,
"dataIn": 0,
"dataOut": 0,
"avgDuration": 0,
"avgOverhead": 0
},
"quotas": {"authorizedCallsPerSec": 0,
"currentCallsPerSec": 0,
"remainingCallsPerSec": 0,
"authorizedCallsPerDay": 0,
"currentCallsPerDay": 0,
"remainingCallsPerDay": 0,
"authorizedCallsPerMonth": 0,
"currentCallsPerMonth": 0,
"remainingCallsPerMonth": 0
},
"billing": {"hits": 0,
"total": 0
},
"from": 0,
"to": 0,
"state": "completed"
}

audit-event

delete a audit-event

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"done": true
}

update a audit-event with JSON patch or by merging JSON object

path Parameters

id

required

string

Request Body schema: application/json
required

the patch to update the audit-event or a JSON object

One of

Array

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

Responses

Request samples

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

Content type

application/json

{"error": "string"
}

update a audit-event

path Parameters

id

required

string

Request Body schema: application/json
required

the audit-event to update

object (object)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a audit-event

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all audit-event

Responses

Response samples

200
401

Content type

application/json

[{ }
]

creates a audit-event

Request Body schema: application/json
required

the audit-event to create

object (object)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201
400
401

Content type

application/json

{ }

message

delete a message

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"done": true
}

update a message with JSON patch or by merging JSON object

path Parameters

id

required

string

Request Body schema: application/json
required

the patch to update the message or a JSON object

One of

Array

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

Responses

Request samples

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

Content type

application/json

{"error": "string"
}

update a message

path Parameters

id

required

string

Request Body schema: application/json
required

the message to update

_id required	string
_tenant required	string
required	MessageType.Tenant (object)
chat required	string user id
participants required	Array of strings
readBy required	Array of strings
date required	integer <timestamp>
sender required	string user id
message required	string
closed	integer or null <timestamp>
send	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"messageType": {"type": "tenant",
"value": "string"
},
"chat": "string",
"participants": ["string"
],
"readBy": ["string"
],
"date": 0,
"sender": "string",
"message": "string",
"closed": 0,
"send": true
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a message

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all message

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"messageType": {"type": "tenant",
"value": "string"
},
"chat": "string",
"participants": ["string"
],
"readBy": ["string"
],
"date": 0,
"sender": "string",
"message": "string",
"closed": 0,
"send": true
}
]

creates a message

Request Body schema: application/json
required

the message to create

_id required	string
_tenant required	string
required	MessageType.Tenant (object)
chat required	string user id
participants required	Array of strings
readBy required	Array of strings
date required	integer <timestamp>
sender required	string user id
message required	string
closed	integer or null <timestamp>
send	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"messageType": {"type": "tenant",
"value": "string"
},
"chat": "string",
"participants": ["string"
],
"readBy": ["string"
],
"date": 0,
"sender": "string",
"message": "string",
"closed": 0,
"send": true
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"_tenant": "string",
"messageType": {"type": "tenant",
"value": "string"
},
"chat": "string",
"participants": ["string"
],
"readBy": ["string"
],
"date": 0,
"sender": "string",
"message": "string",
"closed": 0,
"send": true
}

issue

delete a issue

path Parameters

id

required

string

Responses

Response samples

200
401
404

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

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

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
_deleted	boolean or null
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

Payload

Content type

application/json

{"_id": "string",
"seqId": 0,
"_tenant": "string",
"_deleted": true,
"title": "string",
"tags": ["string"
],
"open": true,
"createdAt": 0,
"closedAt": 0,
"by": "string",
"comments": [{"by": "string",
"createdAt": 0,
"lastModificationAt": 0,
"content": "string"
}
],
"lastModificationAt": 0,
"apiVersion": "string"
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a issue

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all issue

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"seqId": 0,
"_tenant": "string",
"_deleted": true,
"title": "string",
"tags": ["string"
],
"open": true,
"createdAt": 0,
"closedAt": 0,
"by": "string",
"comments": [{"by": "string",
"createdAt": 0,
"lastModificationAt": 0,
"content": "string"
}
],
"lastModificationAt": 0,
"apiVersion": "string"
}
]

creates a issue

Request Body schema: application/json
required

the issue to create

_id required	string
seqId	integer or null <int32>
_tenant required	string
_deleted	boolean or null
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

Payload

Content type

application/json

{"_id": "string",
"seqId": 0,
"_tenant": "string",
"_deleted": true,
"title": "string",
"tags": ["string"
],
"open": true,
"createdAt": 0,
"closedAt": 0,
"by": "string",
"comments": [{"by": "string",
"createdAt": 0,
"lastModificationAt": 0,
"content": "string"
}
],
"lastModificationAt": 0,
"apiVersion": "string"
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"seqId": 0,
"_tenant": "string",
"_deleted": true,
"title": "string",
"tags": ["string"
],
"open": true,
"createdAt": 0,
"closedAt": 0,
"by": "string",
"comments": [{"by": "string",
"createdAt": 0,
"lastModificationAt": 0,
"content": "string"
}
],
"lastModificationAt": 0,
"apiVersion": "string"
}

post

delete a post

path Parameters

id

required

string

Responses

Response samples

200
401
404

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

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

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
_deleted	boolean or null
title required	string
lastModificationAt required	integer <timestamp>
content	string or null

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"title": "string",
"lastModificationAt": 0,
"content": "string"
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a post

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all post

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"_deleted": true,
"title": "string",
"lastModificationAt": 0,
"content": "string"
}
]

creates a post

Request Body schema: application/json
required

the post to create

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

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"title": "string",
"lastModificationAt": 0,
"content": "string"
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"title": "string",
"lastModificationAt": 0,
"content": "string"
}

translation

delete a translation

path Parameters

id

required

string

Responses

Response samples

200
401
404

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

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

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

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"language": "string",
"key": "string",
"value": "string",
"lastModificationAt": 0
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a translation

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all translation

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"language": "string",
"key": "string",
"value": "string",
"lastModificationAt": 0
}
]

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

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"language": "string",
"key": "string",
"value": "string",
"lastModificationAt": 0
}

Response samples

201
400
401

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

200
401
404

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

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

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
_deleted	boolean or null
	object (Currency) Currency
customName required	string
customDescription	string or null
	object (OtoroshiTarget) Otoroshi target
	object (BillingDuration) BillingDuration
allowMultipleKeys	boolean or null
visibility	string Enum: "Public" "Private" "Admin"
authorizedTeams	Array of strings
autoRotation	boolean or null
required	Array of SubscriptionDemandStep.Email (object) or SubscriptionDemandStep.TeamAdmin (object) or SubscriptionDemandStep.Payment (object) or SubscriptionDemandStep.HttpRequest (object)
integrationProcess required	string Enum: "Automatic" "ApiKey"
aggregationApiKeysSecurity	boolean or null
	object (SwaggerAccess) SwaggerAccess
	object (Testing) Testing
	object (ApiDocumentation) ApiDocumentation
maxPerSecond	integer or null <int64>
maxPerDay	integer or null <int64>
maxPerMonth	integer or null <int64>
costPerMonth	integer or null <float64>
costPerRequest	integer or null <float64>
	object (BillingDuration) BillingDuration
	(PaymentSettings.Stripe (object or null))

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"currency": {"code": "string"
},
"customName": "string",
"customDescription": "string",
"otoroshiTarget": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"apikeyCustomization": {"clientIdOnly": true,
"readOnly": true,
"constrainedServicesOnly": true,
"metadata": { },
"customMetadata": { },
"tags": ["string"
],
"restrictions": {"enabled": true,
"allowlast": true,
"allowed": [{"method": "string",
"path": "string"
}
],
"forbidden": [{"method": "string",
"path": "string"
}
],
"notFound": [{"method": "string",
"path": "string"
}
]
}
}
},
"billingDuration": {"value": 0,
"unit": "hour"
},
"allowMultipleKeys": true,
"visibility": "Public",
"authorizedTeams": ["string"
],
"autoRotation": true,
"subscriptionProcess": [{"type": "email",
"id": "string",
"emails": ["user@example.com"
],
"title": "string",
"message": "string"
}
],
"integrationProcess": "Automatic",
"aggregationApiKeysSecurity": true,
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"maxPerSecond": 0,
"maxPerDay": 0,
"maxPerMonth": 0,
"costPerMonth": 0,
"costPerRequest": 0,
"trialPeriod": {"value": 0,
"unit": "hour"
},
"paymentSettings": {"thirdPartyPaymentSettingsId": "string",
"productId": "string",
"priceIds": {"basePriceId": "string",
"additionalPriceId": "string"
}
}
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a usage-plan

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"currency": {"code": "string"
},
"customName": "string",
"customDescription": "string",
"otoroshiTarget": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"apikeyCustomization": {"clientIdOnly": true,
"readOnly": true,
"constrainedServicesOnly": true,
"metadata": { },
"customMetadata": { },
"tags": ["string"
],
"restrictions": {"enabled": true,
"allowlast": true,
"allowed": [{"method": "string",
"path": "string"
}
],
"forbidden": [{"method": "string",
"path": "string"
}
],
"notFound": [{"method": "string",
"path": "string"
}
]
}
}
},
"billingDuration": {"value": 0,
"unit": "hour"
},
"allowMultipleKeys": true,
"visibility": "Public",
"authorizedTeams": ["string"
],
"autoRotation": true,
"subscriptionProcess": [{"type": "email",
"id": "string",
"emails": ["user@example.com"
],
"title": "string",
"message": "string"
}
],
"integrationProcess": "Automatic",
"aggregationApiKeysSecurity": true,
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"maxPerSecond": 0,
"maxPerDay": 0,
"maxPerMonth": 0,
"costPerMonth": 0,
"costPerRequest": 0,
"trialPeriod": {"value": 0,
"unit": "hour"
},
"paymentSettings": {"thirdPartyPaymentSettingsId": "string",
"productId": "string",
"priceIds": {"basePriceId": "string",
"additionalPriceId": "string"
}
}
}

read all usage-plan

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"_deleted": true,
"currency": {"code": "string"
},
"customName": "string",
"customDescription": "string",
"otoroshiTarget": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"apikeyCustomization": {"clientIdOnly": true,
"readOnly": true,
"constrainedServicesOnly": true,
"metadata": { },
"customMetadata": { },
"tags": ["string"
],
"restrictions": {"enabled": true,
"allowlast": true,
"allowed": [{"method": "string",
"path": "string"
}
],
"forbidden": [{"method": "string",
"path": "string"
}
],
"notFound": [{"method": "string",
"path": "string"
}
]
}
}
},
"billingDuration": {"value": 0,
"unit": "hour"
},
"allowMultipleKeys": true,
"visibility": "Public",
"authorizedTeams": ["string"
],
"autoRotation": true,
"subscriptionProcess": [{"type": "email",
"id": "string",
"emails": ["user@example.com"
],
"title": "string",
"message": "string"
}
],
"integrationProcess": "Automatic",
"aggregationApiKeysSecurity": true,
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"maxPerSecond": 0,
"maxPerDay": 0,
"maxPerMonth": 0,
"costPerMonth": 0,
"costPerRequest": 0,
"trialPeriod": {"value": 0,
"unit": "hour"
},
"paymentSettings": {"thirdPartyPaymentSettingsId": "string",
"productId": "string",
"priceIds": {"basePriceId": "string",
"additionalPriceId": "string"
}
}
}
]

creates a usage-plan

Request Body schema: application/json
required

the usage-plan to create

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

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"currency": {"code": "string"
},
"customName": "string",
"customDescription": "string",
"otoroshiTarget": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"apikeyCustomization": {"clientIdOnly": true,
"readOnly": true,
"constrainedServicesOnly": true,
"metadata": { },
"customMetadata": { },
"tags": ["string"
],
"restrictions": {"enabled": true,
"allowlast": true,
"allowed": [{"method": "string",
"path": "string"
}
],
"forbidden": [{"method": "string",
"path": "string"
}
],
"notFound": [{"method": "string",
"path": "string"
}
]
}
}
},
"billingDuration": {"value": 0,
"unit": "hour"
},
"allowMultipleKeys": true,
"visibility": "Public",
"authorizedTeams": ["string"
],
"autoRotation": true,
"subscriptionProcess": [{"type": "email",
"id": "string",
"emails": ["user@example.com"
],
"title": "string",
"message": "string"
}
],
"integrationProcess": "Automatic",
"aggregationApiKeysSecurity": true,
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"maxPerSecond": 0,
"maxPerDay": 0,
"maxPerMonth": 0,
"costPerMonth": 0,
"costPerRequest": 0,
"trialPeriod": {"value": 0,
"unit": "hour"
},
"paymentSettings": {"thirdPartyPaymentSettingsId": "string",
"productId": "string",
"priceIds": {"basePriceId": "string",
"additionalPriceId": "string"
}
}
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"currency": {"code": "string"
},
"customName": "string",
"customDescription": "string",
"otoroshiTarget": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"apikeyCustomization": {"clientIdOnly": true,
"readOnly": true,
"constrainedServicesOnly": true,
"metadata": { },
"customMetadata": { },
"tags": ["string"
],
"restrictions": {"enabled": true,
"allowlast": true,
"allowed": [{"method": "string",
"path": "string"
}
],
"forbidden": [{"method": "string",
"path": "string"
}
],
"notFound": [{"method": "string",
"path": "string"
}
]
}
}
},
"billingDuration": {"value": 0,
"unit": "hour"
},
"allowMultipleKeys": true,
"visibility": "Public",
"authorizedTeams": ["string"
],
"autoRotation": true,
"subscriptionProcess": [{"type": "email",
"id": "string",
"emails": ["user@example.com"
],
"title": "string",
"message": "string"
}
],
"integrationProcess": "Automatic",
"aggregationApiKeysSecurity": true,
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"maxPerSecond": 0,
"maxPerDay": 0,
"maxPerMonth": 0,
"costPerMonth": 0,
"costPerRequest": 0,
"trialPeriod": {"value": 0,
"unit": "hour"
},
"paymentSettings": {"thirdPartyPaymentSettingsId": "string",
"productId": "string",
"priceIds": {"basePriceId": "string",
"additionalPriceId": "string"
}
}
}

subscription-demand

delete a subscription-demand

path Parameters

id

required

string

Responses

Response samples

200
401
404

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

Payload

Content type

application/json

Example

patch

[ ]

Response samples

401
404

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
_deleted	boolean
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

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"api": "string",
"plan": "string",
"steps": [{"type": "email",
"id": "string",
"emails": ["user@example.com"
],
"title": "string",
"message": "string"
}
],
"state": {"id": "string",
"state": "waiting",
"step": { },
"metadata": { }
},
"team": "string",
"from": "string",
"date": 0,
"motivation": "string",
"parentSubscriptionId": "string",
"customReadOnly": true,
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"adminCustomName": "string"
}

Response samples

401
404

Content type

application/json

{"error": "string"
}

read a subscription-demand

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{ }

read all subscription-demand

Responses

Response samples

200
401

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"_deleted": true,
"api": "string",
"plan": "string",
"steps": [{"type": "email",
"id": "string",
"emails": ["user@example.com"
],
"title": "string",
"message": "string"
}
],
"state": {"id": "string",
"state": "waiting",
"step": { },
"metadata": { }
},
"team": "string",
"from": "string",
"date": 0,
"motivation": "string",
"parentSubscriptionId": "string",
"customReadOnly": true,
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"adminCustomName": "string"
}
]

creates a subscription-demand

Request Body schema: application/json
required

the subscription-demand to create

_id required	string
_tenant required	string
_deleted	boolean
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

Payload

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"api": "string",
"plan": "string",
"steps": [{"type": "email",
"id": "string",
"emails": ["user@example.com"
],
"title": "string",
"message": "string"
}
],
"state": {"id": "string",
"state": "waiting",
"step": { },
"metadata": { }
},
"team": "string",
"from": "string",
"date": 0,
"motivation": "string",
"parentSubscriptionId": "string",
"customReadOnly": true,
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"adminCustomName": "string"
}

Response samples

201
400
401

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"api": "string",
"plan": "string",
"steps": [{"type": "email",
"id": "string",
"emails": ["user@example.com"
],
"title": "string",
"message": "string"
}
],
"state": {"id": "string",
"state": "waiting",
"step": { },
"metadata": { }
},
"team": "string",
"from": "string",
"date": 0,
"motivation": "string",
"parentSubscriptionId": "string",
"customReadOnly": true,
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"adminCustomName": "string"
}

integration-apis

get all public apis for integration

header Parameters

X-Personal-Token

required

string

Responses

Response samples

200
401
404

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"name": "string",
"lastUpdate": 0,
"description": "string",
"smallDescription": "string",
"header": "string",
"image": "string",
"currentVersion": "string",
"supportedVersions": ["string"
],
"isDefault": true,
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"tags": ["string"
],
"categories": ["string"
],
"visibility": "Public",
"possibleUsagePlans": ["string"
],
"defaultUsagePlan": "string",
"authorizedTeams": ["string"
],
"posts": ["string"
],
"issues": ["string"
],
"issuesTags": [{"id": "string",
"name": "string",
"color": "string"
}
],
"stars": 0,
"parent": "string",
"apis": ["string"
],
"state": "created"
}
]

get all teams for integration

path Parameters

teamId

required

string

header Parameters

X-Personal-Token

required

string

Responses

Response samples

200
401
404

Content type

application/json

[{"_id": "string",
"_tenant": "string",
"_deleted": true,
"type": "Personal",
"name": "string",
"description": "string",
"contact": "string",
"avatar": "string",
"users": [{"userId": "string",
"teamPermission": "Administrator"
}
],
"authorizedEntities": [{"otoroshiSettingsId": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
}
}
],
"apiKeyVisibility": "administrator",
"metadata": { },
"apisCreationPermission": true,
"verified": true
}
]

get complete API for integration

path Parameters

teamId required	string
apiId required	string

header Parameters

X-Personal-Token

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"type": "Personal",
"name": "string",
"description": "string",
"contact": "string",
"avatar": "string",
"users": [{"userId": "string",
"teamPermission": "Administrator"
}
],
"authorizedEntities": [{"otoroshiSettingsId": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
}
}
],
"apiKeyVisibility": "administrator",
"metadata": { },
"apisCreationPermission": true,
"verified": true
}

get API description

path Parameters

teamId required	string
apiId required	string

header Parameters

X-Personal-Token

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"name": "string",
"lastUpdate": 0,
"description": "string",
"smallDescription": "string",
"header": "string",
"image": "string",
"currentVersion": "string",
"supportedVersions": ["string"
],
"isDefault": true,
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"tags": ["string"
],
"categories": ["string"
],
"visibility": "Public",
"possibleUsagePlans": ["string"
],
"defaultUsagePlan": "string",
"authorizedTeams": ["string"
],
"posts": ["string"
],
"issues": ["string"
],
"issuesTags": [{"id": "string",
"name": "string",
"color": "string"
}
],
"stars": 0,
"parent": "string",
"apis": ["string"
],
"state": "created"
}

get API plans

path Parameters

teamId required	string
apiId required	string

header Parameters

X-Personal-Token

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"name": "string",
"lastUpdate": 0,
"description": "string",
"smallDescription": "string",
"header": "string",
"image": "string",
"currentVersion": "string",
"supportedVersions": ["string"
],
"isDefault": true,
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"tags": ["string"
],
"categories": ["string"
],
"visibility": "Public",
"possibleUsagePlans": ["string"
],
"defaultUsagePlan": "string",
"authorizedTeams": ["string"
],
"posts": ["string"
],
"issues": ["string"
],
"issuesTags": [{"id": "string",
"name": "string",
"color": "string"
}
],
"stars": 0,
"parent": "string",
"apis": ["string"
],
"state": "created"
}

get API documentation

path Parameters

teamId required	string
apiId required	string

header Parameters

X-Personal-Token

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"name": "string",
"lastUpdate": 0,
"description": "string",
"smallDescription": "string",
"header": "string",
"image": "string",
"currentVersion": "string",
"supportedVersions": ["string"
],
"isDefault": true,
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"tags": ["string"
],
"categories": ["string"
],
"visibility": "Public",
"possibleUsagePlans": ["string"
],
"defaultUsagePlan": "string",
"authorizedTeams": ["string"
],
"posts": ["string"
],
"issues": ["string"
],
"issuesTags": [{"id": "string",
"name": "string",
"color": "string"
}
],
"stars": 0,
"parent": "string",
"apis": ["string"
],
"state": "created"
}

get API description

path Parameters

teamId required	string
apiId required	string

header Parameters

X-Personal-Token

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"name": "string",
"lastUpdate": 0,
"description": "string",
"smallDescription": "string",
"header": "string",
"image": "string",
"currentVersion": "string",
"supportedVersions": ["string"
],
"isDefault": true,
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"tags": ["string"
],
"categories": ["string"
],
"visibility": "Public",
"possibleUsagePlans": ["string"
],
"defaultUsagePlan": "string",
"authorizedTeams": ["string"
],
"posts": ["string"
],
"issues": ["string"
],
"issuesTags": [{"id": "string",
"name": "string",
"color": "string"
}
],
"stars": 0,
"parent": "string",
"apis": ["string"
],
"state": "created"
}

get API

path Parameters

teamId required	string
apiId required	string

header Parameters

X-Personal-Token

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"_id": "string",
"_tenant": "string",
"_deleted": true,
"team": "string",
"name": "string",
"lastUpdate": 0,
"description": "string",
"smallDescription": "string",
"header": "string",
"image": "string",
"currentVersion": "string",
"supportedVersions": ["string"
],
"isDefault": true,
"testing": {"enabled": true,
"auth": "ApiKey",
"name": "string",
"username": "string",
"password": "string",
"config": {"otoroshiSettings": "string",
"authorizedEntities": {"services": ["string"
],
"groups": ["string"
],
"routes": ["string"
]
},
"clientName": "string",
"tag": "string",
"customMetadata": { },
"customMaxPerSecond": 0,
"customMaxPerDay": 0,
"customMaxPerMonth": 0,
"customReadOnly": true
}
},
"documentation": {"_id": "string",
"_tenant": "string",
"pages": [{"id": "string",
"title": "string",
"children": [{ }
]
}
],
"lastModificationAt": 0
},
"swagger": {"url": "string",
"content": "string",
"headers": { }
},
"tags": ["string"
],
"categories": ["string"
],
"visibility": "Public",
"possibleUsagePlans": ["string"
],
"defaultUsagePlan": "string",
"authorizedTeams": ["string"
],
"posts": ["string"
],
"issues": ["string"
],
"issuesTags": [{"id": "string",
"name": "string",
"color": "string"
}
],
"stars": 0,
"parent": "string",
"apis": ["string"
],
"state": "created"
}

GraphQL

search with GraphQL

Request Body schema: application/json
required

GraphQL query

One of

query

string

Responses

Request samples

Payload

Content type

application/json

{"query": "string"
}

Response samples

200

Content type

application/json

{"data": { }
}

search with GraphQL

Request Body schema: application/json
required

get GraphQL schema

One of

query

string

Responses

Request samples

Payload

Content type

application/json

{"query": "string"
}

Response samples

200

Content type

application/json

{ }

Integration ApiKey

get apikey from integration token

path Parameters

token

required

string

integration token

Responses

Response samples

200

Content type

application/json

{"clientName": "string",
"clientId": "string",
"clientSecret": "string"
}

Daikoku Admin API (16.3.0)

tenant

delete a tenant

path Parameters

Responses

Response samples

update a tenant with JSON patch or by merging JSON object

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

update a tenant

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

read a tenant

path Parameters

Responses

Response samples

read all tenant

Responses

Response samples

create a tenant

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

user

delete a user

path Parameters

Responses

Response samples

update a user with JSON patch or by merging JSON object

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

update a user

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

read a user

path Parameters

Responses

Response samples

read all user

Responses

Response samples

creates a user

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

team

delete a team

path Parameters

Responses

Response samples

update a team with JSON patch or by merging JSON object

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

update a team

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

read a team

path Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required