APaptible
Settings

create setting

Changed on

Creates a new setting for the specified service.

post/services/{service_id}/settings

Request

  • Base URL
    https://api.aptible.com
  • Auth
    API key in header Authorization

Path parameters

service_idinteger required

service_id

Query parameters

no_embedboolean

When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.

Headers

Prefer'no_sensitive_extras=true'

When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.

Request body

settingsobject

Mapping of non-sensitive key-value pairs

sensitive_settingsobject

Mapping of sensitive key-value pairs

Response

successful

idinteger required
_typestring required
settingsobject required
sensitive_settingsobject

Changes

  • 1dc1e5b8c6ebRevision changes
    • breaking

      the response property became optional for the status

    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed

  • 9f13a846724cRevision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status