We're delighted to present you with the comprehensive API documentation for PEAX. This all-in-one workspace for API design offers you a clear, concise, and interactive exploration of our API functionalities.

Close the forwarding process

PUT

https://proxy-stage.peax.ch/core-service-input-scanning/agent-api/v1/sources/{sourceId}/forwardings/close

close forwarding

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

sourceId

string

required

Header Params

Authorization

string

optional

Default:

Bearer {{JWT}}

Body Params application/json

List of shipment IDs to mark as closed

shipmentIds

array[string <uuid>]

required

Example

{
  "shipmentIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://proxy-stage.peax.ch/core-service-input-scanning/agent-api/v1/sources//forwardings/close' \
--header 'Authorization: Bearer {{JWT}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shipmentIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}'

Responses

🟢204Forwarding Process has been closed

application/json

Body

object {0}

Example

{}

🟠400Bad request

🟠401Unauthorized

🟠403Permission denied

🔴500Internal server error

Modified at 2024-02-29 01:37:11

Download forwarding cover letter

Overview