API

API Keys and Traffic Management API
API summary
OpenAPI schema
Get started
API concepts
Throttle API traffic
Control API access and usage
API workflow
Errors
- Problem Details
- 400
- 401
- 403
- 404
- 405
- 500

Key collections

Key collections
ACLs
- Get an ACLget
- Edit an ACLput
Collection endpoints
- List collection endpointsget
Collection keys
- Import keyspost
- Returns collection keys in JSON, XML or CSV formatget
Quota settings
- Get quota settingsget
- Edit quota settingsput
Reset
- Reset collection key quotapost

Throttling counters

Throttling counters

Keys

Keys
Reset
- Reset key quotapost

Get an ACL

get https://{hostname}/apikey-manager-api/v2/collections/{collectionId}/acl-entries

Returns the access control list of a collection.

Path Params

collectionId

int64

required

Identifies the collection. Run the List key collections operation to select one.

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.

Responses

Response body

object

endpointIds

array of int64s

required

length ≥ 0

Unique set of endpoint identifiers. Run the List collection endpoints operation to get them.

endpointIds*

methodIds

array of int64s

required

length ≥ 0

Unique set of endpoint resource method identifiers. Run the List collection endpoints operation to get them.

methodIds*

resourceIds

array of int64s

required

length ≥ 0

Unique set of endpoint resource identifiers. Run the List collection endpoints operation to get them.

resourceIds*

Response body

object

detail

string

required

length ≥ 1

Detailed error message.

errors

array of objects

length ≥ 0

Further nested problem objects.

errors

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

instance

string

length ≥ 1

Unique value generated with each API call.

status

integer

100 to 600

HTTP status code that categorizes this error case.

title

string

required

length ≥ 1

Summary of each error case.

type

uri

required

Identifies each error case.

instance

string

required

length ≥ 1

Non-referenceable URI indicating an error instance.

status

integer

required

100 to 600

HTTP status code of the error response.

title

string

required

length ≥ 1

Title of the error response.

type

uri

required

URL for the error type description.

Response body

object

detail

string

required

length ≥ 1

Detailed error message.

errors

array of objects

length ≥ 0

Further nested problem objects.

errors

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

instance

string

length ≥ 1

Unique value generated with each API call.

status

integer

100 to 600

HTTP status code that categorizes this error case.

title

string

required

length ≥ 1

Summary of each error case.

type

uri

required

Identifies each error case.

instance

string

required

length ≥ 1

Non-referenceable URI indicating an error instance.

status

integer

required

100 to 600

HTTP status code of the error response.

title

string

required

length ≥ 1

Title of the error response.

type

uri

required

URL for the error type description.

Response body

object

detail

string

required

length ≥ 1

Detailed error message.

errors

array of objects

length ≥ 0

Further nested problem objects.

errors

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

instance

string

length ≥ 1

Unique value generated with each API call.

status

integer

100 to 600

HTTP status code that categorizes this error case.

title

string

required

length ≥ 1

Summary of each error case.

type

uri

required

Identifies each error case.

instance

string

required

length ≥ 1

Non-referenceable URI indicating an error instance.

status

integer

required

100 to 600

HTTP status code of the error response.

title

string

required

length ≥ 1

Title of the error response.

type

uri

required

URL for the error type description.

Response body

object

detail

string

required

length ≥ 1

Detailed error message.

errors

array of objects

length ≥ 0

Further nested problem objects.

errors

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

instance

string

length ≥ 1

Unique value generated with each API call.

status

integer

100 to 600

HTTP status code that categorizes this error case.

title

string

required

length ≥ 1

Summary of each error case.

type

uri

required

Identifies each error case.

instance

string

required

length ≥ 1

Non-referenceable URI indicating an error instance.

status

integer

required

100 to 600

HTTP status code of the error response.

title

string

required

length ≥ 1

Title of the error response.

type

uri

required

URL for the error type description.

Response body

object

detail

string

required

length ≥ 1

Detailed error message.

errors

array of objects

length ≥ 0

Further nested problem objects.

errors

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

instance

string

length ≥ 1

Unique value generated with each API call.

status

integer

100 to 600

HTTP status code that categorizes this error case.

title

string

required

length ≥ 1

Summary of each error case.

type

uri

required

Identifies each error case.

instance

string

required

length ≥ 1

Non-referenceable URI indicating an error instance.

status

integer

required

100 to 600

HTTP status code of the error response.

title

string

required

length ≥ 1

Title of the error response.

type

uri

required

URL for the error type description.

Response body

object

detail

string

required

length ≥ 1

Detailed error message.

errors

array of objects

length ≥ 0

Further nested problem objects.

errors

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

instance

string

length ≥ 1

Unique value generated with each API call.

status

integer

100 to 600

HTTP status code that categorizes this error case.

title

string

required

length ≥ 1

Summary of each error case.

type

uri

required

Identifies each error case.

instance

string

required

length ≥ 1

Non-referenceable URI indicating an error instance.

status

integer

required

100 to 600

HTTP status code of the error response.

title

string

required

length ≥ 1

Title of the error response.

type

uri

required

URL for the error type description.

Updated about 1 year ago

Delete a key collection

Edit an ACL

Did this page help you?

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/apikey-manager-api/v2/collections/collectionId/acl-entries \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
{
2
  "endpointIds": [
3
    538102
4
  ],
5
  "methodIds": [],
6
  "resourceIds": []
7
}

Updated about 1 year ago

Delete a key collection

Edit an ACL

Did this page help you?

API
API Keys and Traffic Management API
API summary
Get started
API concepts
Throttle API traffic
Control API access and usage
API workflow
Errors
500
405
404
403
401
400

Key collections
Key collections
Delete a key collectiondelete
Edit a key collectionput
Get a key collectionget
List key collectionsget
Create a key collectionpost
ACLs
Edit an ACLput
Get an ACLget
Collection endpoints
List collection endpointsget
Collection keys
Returns collection keys in JSON, XML or CSV formatget
Import keyspost
Quota settings
Edit quota settingsput
Get quota settingsget
Reset
Reset collection key quotapost

Throttling counters
Throttling counters
List counter keysget
List counter key collectionsget
List counter endpointsget
Delete a throttling counterdelete
Edit a throttling counterput
Get a throttling counterget
List throttling countersget
Create a throttling counterpost

Keys
Keys
Edit a keyput
Get a keyget
Unassign keyspost
Revoke keyspost
Restore revoked keyspost
Move keyspost
Generate keyspost
Export keysget
Assign keyspost
List keysget
Create keyspost
Reset
Reset key quotapost

Tags
Tags
List tagsget

200The response provides the ACL.

400Bad request. The request contains invalid data.

401Unauthorized. You are not authorized to perform the action.

403Forbidden. You don't have permission to the resource.

404Not found. The resource doesn't exist.

405Method not allowed.

500Internal server error.