API status

GET 
/api/system/status

Return runtime status of the API and statistics about it.

Request

Header Parameters

x-correlation-id X-Correlation-Id
Correlation ID is a special type of request ID which is unique over a series of requests and responses, identifying a transaction in a distributed system. Correlation ID will be generated if not provided.
Default value:
x-request-id X-Request-Id
In distributed system architecture (microservices architecture) it is a unique ID of request and response combination throughout all components of a distributed system. Request ID will be generated if not provided.
Default value:

Responses

200

Successful Response

application/json

Schema

Schema

storages object[]required
List of available file storages with their status.
Array [
typeType (string)required
Storage type.
Possible values: [input, internal, output]
capacityCapacity (integer)required
Maximum capacity of the storage in bytes.
usageUsage (integer)required
Current usage of the storage in bytes.
]

Example (auto)

{
  "storages": [
    {
      "type": "input",
      "capacity": 0,
      "usage": 0
    }
  ]
}

400

Request payload data was invalid and could not be parsed.

application/json

Schema

Schema

typeRequestErrorType (string)required
Machine-readable error type.
Possible values: [internal, resource.not-found, method.invalid, request.conflict, request.forbidden, request.invalid, request.validation-error, request.rate-limit-exceeded, request.size-limit-exceeded, storage.capacity-exceeded]
messageMessage (string)required
Human-readable summary of the error.
detail object[]
Optional higher level of detail. It is intended for better understanding of the error or advanced error handling.
Array [
location object[]required
Location of the error.
Array [
anyOf
MOD1
integer
MOD2
string
]
messageMessage (string)required
Human-readable summary of the error.
typeType (string)required
Machine-readable error type.
context object
Optional key-value object with additional context
property name* object
anyOf
MOD1
string
MOD2
integer
MOD3
number
MOD4
boolean
MOD5
Array [
anyOf
MOD1
string
MOD2
integer
MOD3
number
MOD4
boolean
]
]

Example (auto)

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

request.invalid

Invalid request.

{
  "type": "request.invalid",
  "message": "Invalid request.",
  "detail": []
}

422

Error during validation of request payload data occurred.

application/json

Schema

Schema

typeRequestErrorType (string)required
Machine-readable error type.
Possible values: [internal, resource.not-found, method.invalid, request.conflict, request.forbidden, request.invalid, request.validation-error, request.rate-limit-exceeded, request.size-limit-exceeded, storage.capacity-exceeded]
messageMessage (string)required
Human-readable summary of the error.
detail object[]
Optional higher level of detail. It is intended for better understanding of the error or advanced error handling.
Array [
location object[]required
Location of the error.
Array [
anyOf
MOD1
integer
MOD2
string
]
messageMessage (string)required
Human-readable summary of the error.
typeType (string)required
Machine-readable error type.
context object
Optional key-value object with additional context
property name* object
anyOf
MOD1
string
MOD2
integer
MOD3
number
MOD4
boolean
MOD5
Array [
anyOf
MOD1
string
MOD2
integer
MOD3
number
MOD4
boolean
]
]

Example (auto)

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

request validation error

Request validation error.

{
  "type": "request.validation-error",
  "message": "Request validation error.",
  "detail": []
}

429

Request rate limit exceeded.

The request may be retried after a while. The following response headers may be checked for details: retry-after, x-ratelimit-limit, x-ratelimit-remaining, x-ratelimit-reset.

Response Headers

retry-after

Header indicates how long the user agent should wait before making a follow-up request.

x-ratelimit-limit

Size of the current rate limiting window.

x-ratelimit-remaining

Remaining number of requests in the current rate limiting window.

x-ratelimit-reset

Time at which the current rate limiting window resets (in UTC epoch).

application/json

Schema

Schema

typeRequestErrorType (string)required
Machine-readable error type.
Possible values: [internal, resource.not-found, method.invalid, request.conflict, request.forbidden, request.invalid, request.validation-error, request.rate-limit-exceeded, request.size-limit-exceeded, storage.capacity-exceeded]
messageMessage (string)required
Human-readable summary of the error.
detail object[]
Optional higher level of detail. It is intended for better understanding of the error or advanced error handling.
Array [
location object[]required
Location of the error.
Array [
anyOf
MOD1
integer
MOD2
string
]
messageMessage (string)required
Human-readable summary of the error.
typeType (string)required
Machine-readable error type.
context object
Optional key-value object with additional context
property name* object
anyOf
MOD1
string
MOD2
integer
MOD3
number
MOD4
boolean
MOD5
Array [
anyOf
MOD1
string
MOD2
integer
MOD3
number
MOD4
boolean
]
]

Example (auto)

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

request.rate-limit-exceeded

Rate limit exceeded.

{
  "type": "request.rate-limit-exceeded",
  "message": "Rate limit exceeded: 1 per 5 second.",
  "detail": []
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://docs.cloud.phonexia.com/api/system/status");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());