Skip to main content

Lists the NHI data regions an organization can be homed in​

Discovery for the nhi_region choice at organization creation (sign-up, AWS Marketplace, sub-organization). regions is the exact set those requests accept; core is the default. An organization's region is immutable once created. Accepts a session (Bearer) token or an API key.

Header Parameters
  • SlashID-OrgID string

    Required when authenticating with an API key: the organization whose key, or whose manager's key, is presented. Not used to authenticate session tokens. Must be a single value when present.

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses

OK

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

  • errors object[]
  • httpcode integer
  • message string
  • code string

    Machine-readable reason, present only for errors that define one. Values today: unserved_org_region (the organization is homed in a region this deployment does not serve), wrong_region (the request must be sent to the organization's home region), region_route_missing (this instance has no route to the organization's home region).

  • result object

    The NHI data regions of this deployment: the set an organization's nhi_region may name at creation. core is the default applied when no nhi_region is given.

  • core string

    Possible values: [us-iowa, europe-belgium, asia-japan, europe-england, australia-sydney]

  • regions string[]

    Possible values: [us-iowa, europe-belgium, asia-japan, europe-england, australia-sydney]