Retrieve a specific organization

Returns a specific organization from the store

get/organizations/{id}

Request

Base URL
/chronograf/v1 (relative, and the document was published on a file host, not at the API’s origin)
URL
/chronograf/v1/organizations/{id}
Auth
none declared

Path parameters

idstring required

ID of the organization

Response

An Organization object

defaultRole'member' | 'viewer' | 'editor' | 'admin'

The default role that new users in this organization will have.

idstring

Unique identifier representing an organization resource. The Default organization will have the id 'default', and any further will start at '1' and increment.

namestring required

User-facing name of the organization resource.

Example response

{
  "defaultRole": "viewer",
  "id": "1",
  "links": {
    "self": "/chronograf/v1/organizations/1"
  },
  "name": "Chronogiraffes"
}

Changes

No recorded changes to this operation across all 71 revisions of this API.