Cloudability API

Cloudability API Documentation

Welcome to the Cloudability API documentation.

At Cloudability our public API is a first class citizen. As much as we know you love using our console, a well factored API can deliver and enable myriad use cases beyond even our imagination.
If you are a large public cloud user you'll find intelligent ways to automate scripting of repetitive tasks that would be impractical to manage manually at the scale you require. We also expect to see more machine to machine integrations where information is be shared between systems, augmenting important data sets and supporting the delivery of information to end users in a medium that works for them.

Get Started

Users

Manage users

All of the standard CRUD actions to manage users within your account.

List of users in your organization

GET /api/1/users/?auth_token=<your_auth_token>

1. Parameters

This method has no parameters except for authentication.

1. Example Response

[
  {
    id: 1,
    email: "john@cloudability.com",
    full_name: "John Doe",
    invitation: "pending",
    role: "Administrator",
    restricted: false,
    shared_dimension_filter_set_ids: [ ],
    default_dimension_filter_set_id: null
  }
]

Add a user to your organization

POST /api/1/users/?auth_token=<your_auth_token>

2. Parameters

All of the following paramaters must belong to a root parameter of user

email: Required (string) The email address of the user
full_name: (string) The full name of the user
role: (string) Role assigned to the user
restricted: (boolean) True if the user is allowed to have no filter set applied, false if they must always have a filter set applied
new_shared_dimension_filter_set_ids: (array) Array of filter sets ids available to the user
default_dimension_filter_set_id: (integer) Filter set id used by default for the user

2. Example Payload

{
  "user": {
    "full_name": "John Doe",
    "role": "Administrator",
    "restricted": false,
    "email": "john@cloudability.com",
    "default_dimension_filter_set_id": null,
    "new_shared_dimension_filter_set_ids": [],
    "unshare_existing_dimension_filter_sets": true
  }
}

2. Example Response

[
  {
    id: 1,
    email: "john@cloudability.com",
    full_name: "John Doe",
    invitation: "pending",
    role: "Administrator",
    restricted: false,
    shared_dimension_filter_set_ids: [],
    default_dimension_filter_set_id: null
  }
]

Update a user to your organization

PUT /api/1/users/:id?auth_token=<your_auth_token>

3. Parameters

All of the following paramaters must belong to a root parameter of user

  • Note: do NOT provide the email address with updates. This cannot be changed.

full_name: (string) The full name of the user
role: (string) Role assigned to the user
restricted: (boolean) True if the user is allowed to have no filter set applied, false if they must always have a filter set applied
new_shared_dimension_filter_set_ids: (array) Array of filter sets ids available to the user
default_dimension_filter_set_id: (integer) Filter set id used by default for the user

3. Example Payload

{
  "user": {
    "full_name": "John Doe",
    "role": "Administrator",
    "restricted": false,
    "default_dimension_filter_set_id": null,
    "new_shared_dimension_filter_set_ids": [],
    "unshare_existing_dimension_filter_sets": true
  }
}

3. Example Response

[
  {
    id: 1,
    email: "john@cloudability.com",
    full_name: "John Doe",
    invitation: "pending",
    role: "Administrator",
    restricted: false,
    shared_dimension_filter_set_ids: [],
    default_dimension_filter_set_id: null
  }
]

Delete a user in your organization

DELETE /api/1/users/:id?auth_token=<your_auth_token>

4. Parameters

id: integer (required)

Users


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.