Home
API reference
Platform API
Platform API
Sources
Delete portmap

Delete portmap

delete/v1/sources/{sourceId}/portmaps/{portmapId}
Page View

Source endpoints allow you to manage sources and their related portmaps in a specified environment. Portmaps include a port, virtual host (vhost), source, and list of host IPs.

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

Delete portmap

Delete a portmap for the specified MLLP source within your Redox organization.

Request parameters and payload

cURL request example

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

Path Parameters

  • sourceId
    required, string

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

  • portmapId
    required, number

    Displays the unique identifier of a portmap.

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 portmap no longer exists.