Skip to main content

Create a Custom API Entry using the settings endpoint

POST 

/v2/settings/extensions/custom-apis/:custom_api_id/entries

Create a Custom API Entry using the settings endpoint

Request

Path Parameters

    custom_api_id stringrequired

    The id of the Custom API.

    Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Body

    data CustomApiEntryAttributesrequired
    type string

    Specifies the type of the resource object, use the api_type of the Custom API for Custom API Entry.

    links object
    meta object
    timestamps objectrequired

Responses

Created

Response Headers
  • ETag string

    A unique identifier representing the current version of the resource. When the resource changes, the ETag value will also change. The ETag hash will be the same value as etag_id, and is marked as a weak entity tag string. For example: etag: W/"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9", etag_id: 5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9

Schema
    data objectrequired
    id uuidrequired

    The unique identifier for the Custom API Entry

    type stringrequired

    Specifies the type of the resource object, use the api_type of the Custom API for Custom API Entry.

    links object
    self uri

    Specifies the URI of the Custom API Entry.

    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.

    data_size integerrequired

    Default value: 0

    Specifies the sum of the size of each value stored for the Custom API Entry in bytes. The total size of a Custom API Entry must not exceed 64KB.

    resource_version integer

    Default value: 0

    A unique identifier representing the current version of the resource. When the resource changes, the resource_version value will also change.

    etag_id string

    A unique identifier representing the current version of the resource that is a hashed string. When the resource changes, the etag_id will also change.

    property name* any
Loading...