Edit API privacy settings

put

https://{hostname}/api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/api-privacy

Updates the API privacy settings configured for an endpoint version and its assigned resources.

Path Params

versionNumber

integer

required

The unique identifier for the endpoint version.

apiEndPointId

integer

required

The unique identifier for the endpoint.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

public

boolean

required

Whether the endpoint is public, that is, accessible without an API key.

resources

object

Specifies each resource's privacy settings. This object is a map of resource IDs to API privacy settings. Applies only when public is set to false.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200The response shows updated privacy settings.

400Bad request. Some of your request's input is invalid.

401Unauthorized. You aren't authorized to perform the action.

403Forbidden. You don't have permission to access the API endpoint.

404Not found. This API endpoint doesn't exist.

405Method not allowed.

415Unsupported Media Type.