CLcloudsmith
orgs

Create an API key rule.

Changed on

Create an API key rule.

post/orgs/{org}/api-key-rules/

Request

  • Base URL
    https://api.cloudsmith.io
  • Auth
    • API key in header X-Api-Key
    • or HTTP basic

Request body

enforce_refreshboolean

When enabled, API keys that violate the organization's rule will be replaced automatically.

is_enabledboolean

Whether this rule is currently active and enforced.

max_age_hoursinteger nullable

The maximum permitted age of an API key for use in the organization. API keys older than this will no longer have access until they are refreshed. To disable the rule unset this value.

refresh_immediatelyboolean

If set to True, API keys that violate this rule will be replaced immediately after the request is made. There is no way to undo this.

rule_type'All Accounts' | 'Service Accounts' | 'User Accounts' required

Specify which account types this rule applies to: all accounts (deprecated — prefer separate service/user rules), service accounts only, or user accounts only.

Response

Created

created_atstring date-time
enforce_refreshboolean

When enabled, API keys that violate the organization's rule will be replaced automatically.

is_enabledboolean

Whether this rule is currently active and enforced.

last_applied_atstring date-time

The last time this rule was evaluated and applied by the expiry task.

max_age_hoursinteger nullable

The maximum permitted age of an API key for use in the organization. API keys older than this will no longer have access until they are refreshed. To disable the rule unset this value.

rule_type'All Accounts' | 'Service Accounts' | 'User Accounts' required

Specify which account types this rule applies to: all accounts (deprecated — prefer separate service/user rules), service accounts only, or user accounts only.

slugstring slug

Human-readable identifier for the rule type. Automatically generated based on the rule type.

slug_permstring slug

An auto-generated id that uniquely identifies the rule.

updated_atstring date-time

Changes