Put Settings

Replace an organisation's own settings.

Request

Method & Path

PUT /organizations/:id/settings

Path parameters

  • id โ€” any organisation in the caller's scope: its own, or a child.

Headers

  • x-api-key โ€” API key.
  • Content-Type โ€” application/json.
  • x-acting-as โ€” optional child organisation ID.

Body

data.attributes.settings replaces the organisation's own settings. A key left out inherits the parent's value. To stop inheriting one key, send that key as an empty list, e.g. { "dashboard_tags": [] }. Send {} to inherit every key.

  • packaging_rules โ€” optional, at most 20, one per target.
    • target โ€” lowercase dot-separated words, e.g. eudr.dds, max 64.
    • selector โ€” tag selector for the locations the rule takes, max 1000.
    • group_by โ€” tag namespace.
  • dashboard_tags โ€” optional, at most 50, each namespace once.
    • namespace โ€” tag namespace.
    • label โ€” display label, max 100.
    • filterable โ€” boolean.

A tag namespace is lowercase letters, digits, underscore or hyphen, with no colon, max 64 characters. Any other key, at any level, is a 400.

The response is the same resource as GET /organizations/:id/settings, read after the write.

Errors

StatusCodeMeaning
400VALIDATION_ERRORUnknown key, bad namespace, repeated target or namespace, or an id that is not a UUID.
401Missing or invalid API key.
403The key does not hold organizations:write.
404NOT_FOUNDThe organisation is not in this key's scope.

Required scope: organizations:write