Home
API reference
Platform API reference
Platform API
Sources
Delete source

Delete source

delete/v1/sources/{sourceId}
Page View

Source endpoints allow you to manage sources in a specified environment.

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

Delete source

Delete an existing source. This operation can't be undone.

The response contains an OK acknowledgement if the delete is successful.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/sources/{sourceId}' \
2
--request DELETE \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

  • sourceId
    required, string

    Displays the unique identifier of an source within a given environment.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "message": "string"
7
  }
8
}

    Describes the outcome of the delete request.

  • 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
    • message
      string

      Explains that the delete request was successful, so the source no longer exists within the specified environment.