Skip to navigation
Management APIKey Sets

Create Key Set

Group some of your keys for one vendor. Name the set on a project or routing policy to send that traffic through these keys.

Authentication

AuthorizationBearer

A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.

Request

This endpoint expects an object.
memberslist of objectsRequired

The keys in the set, by credential id. Each must be one of the organization’s own keys for the set’s vendor. At most 1000.

namestringRequired<=255 characters
A name for the set.
strategyenumRequired

How traffic is spread across the members. failover tries them in order. weighted spreads requests by weight and keeps each conversation on one key. round_robin does the same with equal weights.

Allowed values:
vendorstringRequired<=100 characters
The vendor's slug. Can't change.
fallback_to_managedbooleanOptionalDefaults to true

When no key in the set can serve a request, use Merge-managed access for the vendor, if the organization has it. When false, the request fails instead.

Response

The created key set
created_atdatetime or nullRead-only
When the set was created.
fallback_to_managedboolean

When no key in the set can serve a request, use Merge-managed access for the vendor, if the organization has it. When false, the request fails instead.

idstringRead-onlyformat: "uuid"
The key set's id.
memberslist of objects

The keys in the set, by credential id. Each must be one of the organization’s own keys for the set’s vendor. At most 1000.

namestring
The set's name.
strategystring

How traffic is spread across the members. failover tries them in order. weighted spreads requests by weight and keeps each conversation on one key. round_robin does the same with equal weights.

updated_atdatetime or nullRead-only
When the set last changed.
vendorstring
The vendor's slug.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable Error