Hotline API

Create Request Schema

POST /request-schemas
Bearer auth

Create schema for request validation

Query parameters

  • title string

    name of file

    Minimum length is 0, maximum length is 128. Format should match the following pattern: [a-zA-Z0-9 _-].

application/octet-stream

Body Required

Schema definition

string(binary) string(binary)

https://json-schema.org/draft/2020-12/json-schema-core.html

Minimum length is 2, maximum length is 355000.

Responses

  • 201 application/json

    Created request schema

    Hide response attributes Show response attributes object
    • schemaID string Required

      Minimum length is 24, maximum length is 24. Format should match the following pattern: SC[A-Za-z0-9_\-]+.

    • updatedAt string(date-time) Required

      https://datatracker.ietf.org/doc/html/rfc3339#section-5.6 - RFC3339 date-time in UTC

      Minimum length is 20, maximum length is 20.
  • 400 application/json

    Bad request

    Hide response attributes Show response attributes object
    • code string(string) Required

      Error code

      Minimum length is 1, maximum length is 64.

    • message string(string) Required

      Human-readable error message

      Minimum length is 1, maximum length is 1024.
  • 401 application/json

    Unauthorized request

    Hide response attributes Show response attributes object
    • code string(string) Required

      Error code

      Minimum length is 1, maximum length is 64.

    • message string(string) Required

      Human-readable error message

      Minimum length is 1, maximum length is 1024.
  • 429 application/json

    Too many requests

    Hide response attributes Show response attributes object
    • code string(string) Required

      Error code

      Minimum length is 1, maximum length is 64.

    • message string(string) Required

      Human-readable error message

      Minimum length is 1, maximum length is 1024.
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • code string(string) Required

      Error code

      Minimum length is 1, maximum length is 64.

    • message string(string) Required

      Human-readable error message

      Minimum length is 1, maximum length is 1024.
POST /request-schemas 
curl \
 --request POST '/api/v1/request-schemas' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/octet-stream" \
 --data-binary '{}'
Response examples (201) 
{
  "schemaID": "SCx3zt0ygAcQGBAQEBAQEBAQ",
  "updatedAt": "2017-07-21T17:32:28Z"
}
Response examples (400) 
{
  "code": "string",
  "message": "string"
}
Response examples (401) 
{
  "code": "string",
  "message": "string"
}
Response examples (429) 
{
  "code": "string",
  "message": "string"
}
Response examples (500) 
{
  "code": "string",
  "message": "string"
}