Get developer portal public access

GET /api/portal/system_settings/public_access

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

Default"default"

curl -X GET "$API_BASE_URL/api/portal/system_settings/public_access"

Successfully retrieved or updated the developer portal settings.

{
  "value": {
    "portal_public_access": true
  }
}

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

Get developer portal public access

Get the current developer portal public access configuration for the specified portal. Use this to verify login and public accessibility settings.

Required IAM Permission: Action portal:GetDeveloperPortalPublicAccess, Resource arn:api7:portal:portal/%s/loginsetting/*

portal_id (query, string, optional): The unique identifier of the portal instance.

200: Successfully retrieved or updated the developer portal settings.
allOf variant 1
value (object, optional): The specific resource.
allOf variant 2
value (object, optional):
value.portal_public_access (boolean, optional): If true, allow public access to the developer portal.
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 GET '$API_BASE_URL/api/portal/system_settings/public_access'