Create a Custom API

POST 
/v2/settings/extensions/custom-apis

Create a Custom API

Request

application/json

Body

data CustomApiAttributesrequired
type stringrequired
Specifies the type of the resource object, use custom_api for Custom APIs.
name stringrequired
Possible values: non-empty and <= 255 characters
Specifies the name of this Custom API.
description string
Possible values: <= 255 characters
Specifies the description for this Custom API.
slug stringrequired
Possible values: Value must match regular expression ^[a-z0-9_-]{1,63}$
Specifies a unique slug identifier for the Custom API. The API Entries for the created Custom API will be accessible at the location /v2/extensions/<slug>.
api_type stringrequired
Possible values: Value must match regular expression ^[a-z0-9_]{1,59}_ext$
Specifies a unique API type for this Custom API. Entries for this API will use this value for their type field. This field must be suffixed with _ext to distinguish it from built in APIs.
links object
meta object
timestamps objectrequired

Responses

201

Created

application/json

Schema

Schema

data objectrequired

id uuid

The unique identifier for the Custom API.

type stringrequired

Specifies the type of the resource object, use custom_api for Custom APIs.

name stringrequired

Possible values: non-empty and <= 255 characters

Specifies the name of this Custom API.

description string

Possible values: <= 255 characters

Specifies the description for this Custom API.

slug stringrequired

Possible values: Value must match regular expression ^[a-z0-9_-]{1,63}$

Specifies a unique slug identifier for the Custom API. The API Entries for the created Custom API will be accessible at the location /v2/extensions/<slug>.

api_type stringrequired

Possible values: Value must match regular expression ^[a-z0-9_]{1,59}_ext$

Specifies a unique API type for this Custom API. Entries for this API will use this value for their type field. This field must be suffixed with _ext to distinguish it from built in APIs.

links objectrequired

self uri

Specifies the URI of the Custom API.

meta object

timestamps objectrequired

updated_at stringrequired

Specifies the date the entity is created.

created_at stringrequired

Specifies the date the entity is last updated.

Example (from schema)

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string",
    "name": "string",
    "description": "string",
    "slug": "string",
    "api_type": "string",
    "links": {
      "self": "/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "meta": {
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244Z",
        "created_at": "2017-01-10T11:41:19.244Z"
      }
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

missing-name

Required field missing

{
  "errors": [
    {
      "title": "Bad Request",
      "status": "400",
      "detail": "The field 'name' is required."
    }
  ]
}

409

Unable to perform the operation at this time.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

duplicate-custom-api

Duplicate Custom API

{
  "errors": [
    {
      "title": "Conflict",
      "status": "409",
      "detail": "custom_api with the given api_type already exists"
    }
  ]
}

duplicate-custom-field

Duplicate Custom Field

{
  "errors": [
    {
      "title": "Conflict",
      "status": "409",
      "detail": "custom_field with the given slug already exists"
    }
  ]
}

default

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Loading...