Documentation Powered by Redocly

Rat API (v1)

Download OpenAPI specification:Download

Configurations

Create Configuration

Authorizations:
Bearer
path Parameters
projectId
required
integer <int32>
Request Body schema: application/json
name
string or null
typeId
integer <int32>

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "typeId": 0
}

Get Configuration by Id

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "configurationTypeId": 0,
  • "entries": [
    ]
}

Patch Configuration

Authorizations:
Bearer
path Parameters
projectId
required
integer <int32>
id
required
integer <int32>
Request Body schema: application/json
id
integer <int32>
name
string or null
configurationTypeId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "configurationTypeId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "typeId": 0
}

Delete Configuration

Authorizations:
Bearer
path Parameters
projectId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

Entries

Create Configuration Entry

Authorizations:
Bearer
path Parameters
configurationId
required
integer <int32>
Request Body schema: application/json
key
string or null
value
string or null
secondsToLive
integer <int32>
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "secondsToLive": 0,
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "id": 0
}

Create Configuration Entries

Authorizations:
Bearer
path Parameters
configurationId
required
integer <int32>
Request Body schema: application/json
Array of objects or null (CreateConfigurationEntryRouteInput)

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "ids": [
    ]
}

Patch Configuration Entry

Authorizations:
Bearer
path Parameters
configurationId
required
integer <int32>
id
required
integer <int32>
Request Body schema: application/json
id
integer <int32>
configurationId
integer <int32>
key
string or null
value
string or null
secondsToLive
integer <int32>
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "configurationId": 0,
  • "key": "string",
  • "value": "string",
  • "secondsToLive": 0,
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "value": "string",
  • "secondsToLive": 0,
  • "disabled": true
}

Delete Configuration Entry

Authorizations:
Bearer
path Parameters
configurationId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

Projects

Create Project

Authorizations:
Bearer
Request Body schema: application/json
name
string or null
typeId
integer <int32>

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "typeId": 0
}

Get User Project

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "userId": 0,
  • "projectStats": [
    ]
}

Get Project by Id

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "typeId": 0,
  • "configurations": [
    ]
}

Patch Project

Authorizations:
Bearer
path Parameters
id
required
integer <int32>
Request Body schema: application/json
id
integer <int32>
name
string or null
typeId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "typeId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "typeId": 0
}

Delete Project

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}