Home
API reference
Platform API reference
Platform API
Destinations
Update destination

Update destination

patch/v1/destinations/{destinationId}
Page View

Destination endpoints allow you to manage destinations in a specified environment.

You must be a member of the environment and be assigned to an engineer role to manage destinations. Learn about roles.

Update destination

Replace the auth credential of an existing destination within the specified environment. You must use the correct destination and environment identifiers.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/destinations/{destinationId}' \
2
--request PATCH \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
  "name": "string",
8
  "authCredential": "95dc8346-96b6-4721-88bf-bd96d3ac7a91"
9
}'

Request Body Schema

    Contains the fields that can be provided when updating a destination.

  • name
    string

    Displays the human-readable name of the endpoint that will receive messages from Redox.

  • authCredential
    string

    Displays the unique identifier of the destination's attached auth credential, if any.

    Format: uuid

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "destination": {
7
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
8
      "name": "string",
9
      "authCredential": "95dc8346-96b6-4721-88bf-bd96d3ac7a91",
10
      "environment": {
11
        "id": "string",
12
        "environmentFlag": "Staging"
13
      }
14
    }
15
  }
16
}
  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object

    Contains the payload with details about the requested destination.

    • destination
      object

      Contains an instance of a destination.

      • id
        string

        Displays the unique identifier of the endpoint that will receive messages from Redox.

        Format: uuid
      • name
        string

        Displays the human-readable name of the endpoint that will receive messages from Redox.

      • authCredential
        string

        Displays the unique identifier of the destination's attached auth credential, if any.

        Format: uuid
      • environment
        object

        Contains metadata about the environment.

        • id
          string

          Identifies the specific environment that you're operating in or on behalf of.

        • environmentFlag
          string

          Indicates whether the environment is used for development, staging, or production.

          Possible Values: Production, Staging, Development