Skip to content
Port OS

Upsert Route

← HTTP API reference
View source specification ↗
POST /routes

Creates or updates a route.

Required scope

endpoint:write

Request body

Fields

idstringRequired

The route ID

endpointIdstringRequired

The endpoint ID

pluginIdstringRequired

The plugin ID

interfacesarray<ApplicationInterface>

List of interfaces to support

metadataRouteMetadata

Additional metadata about the route

Returns

200

Route upserted successfully

No response body.

Errors

400

Invalid request payload

Check the request fields and any validation details, then correct the payload.

500

Internal server error

Retry with backoff only when the operation is safe to repeat. Include the error code when reporting persistent failures.