Manage Portal site settings

PUT https://{controlplane_path}/api/1/rest/public/developer_hub/site_settings

Important: This API applies to APIM 3.0, not Classic APIM.

Update APIM 3.0 Developer Portal site settings, such as the URL suffix.

Prerequisites

Environment admin permissions.

Example

This example uses Basic authentication. For a JWT example, refer to Authentication.

curl -X 'PUT' \
  'https://elastic.snaplogic.com/api/1/rest/public/developer_hub/site_settings' \
  -H 'Authorization: Basic {base64_encoded email:password}' \
  -H 'Content-Type: application/json' \
  -d '{
  "org_name": "my-environment",
  "url_suffix": "api-portal"
}'

Request header

Use the application/json content type with basic authentication (email and password) or a JWT. For examples, refer to Authentication.

Request body


Key	Type	Description
`org_name`	string	Required. The name of the environment (Org).
`url_suffix`	string	Required. The URL suffix for the Developer Portal site.

Response


{
  "response_map": {
    "success": "ok"
  },
  "http_status_code": 200
}

Error handling


HTTP status codes	Message	Resolution
401	Unauthorized	Verify your credentials and Environment admin privileges.
403	Not Allowed	You do not have permission to perform this action in this environment.