Modify an API's visibility

put

https://{hostname}/appsec/v1/api-discovery/host/{hostname}/basepath/{basePath}

All products Hide or show an API. You can choose to include or exclude APIs from the Get discovered APIs response. This operation is per-user. If you hide an API from the response, another of your colleagues will still see that API in the response when they run this operation with their own credentials.

Path Params

hostname

string

required

The base64-encoded value of the hostname.

basePath

string

required

The base64-encoded value of the base path.

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

Describes an API's visibility status.

hidden

boolean

required

Describes an API's visibility status.

reason

string

enum

The reason you've decided to hide the API from the API list. Use NOT_ELIGIBLE if you want to hide it for now and choose what to do with the API at a later time. Use FALSE_POSITIVE for APIs you feel are incorrectly included in the data.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200Successfully updated the API's action.

400Invalid. Client error, such as invalid or malformed input.

403Forbidden. You don't have permission to write to this resource.

404Not found. The security policy doesn't exist, doesn't carry application layer controls, or no rule with this ID is available for use in this policy.

500Internal server error. Something went wrong on our side. Try again in a few minutes or contact support if the error persists.