Delete a portal instance

DELETE /api/portals/{portal_id}

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

portal_id*string

The unique identifier of the portal instance.

Match^[a-zA-Z0-9-_.]+$

Length1 <= length <= 256

curl -X DELETE "$API_BASE_URL/api/portals/bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"

Operation completed successfully with no response body.

""

Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.

{
  "value": {},
  "error_msg": "error message"
}

Complete operation details and schema variants

Delete a portal instance

IAM Action: portal:DeletePortal, Resource: arn:api7:portal:portal/%s

portal_id (path, string, required): The unique identifier of the portal instance.

200: Operation completed successfully with no response body.
400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
value (object, optional): The specific resource.
error_msg (string, optional): The error message.

curl -X DELETE '$API_BASE_URL/api/portals/{portal_id}'