API documentation

Examples

GET /api/roles
200
{
  "total": 13,
  "subtotal": 13,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": "name",
    "order": "ASC"
  },
  "results": [
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "Create hosts",
      "id": 9,
      "description": null,
      "origin": ""
    },
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "CRUD hosts",
      "id": 12,
      "description": null,
      "origin": ""
    },
    {
      "builtin": 2,
      "cloned_from_id": null,
      "name": "Default role",
      "id": 7,
      "description": null,
      "origin": "foreman"
    },
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "Destroy hosts",
      "id": 8,
      "description": null,
      "origin": ""
    },
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "Edit hosts",
      "id": 4,
      "description": null,
      "origin": "foreman"
    },
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "Edit partition tables",
      "id": 2,
      "description": null,
      "origin": "foreman"
    },
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "Manager",
      "id": 1,
      "description": null,
      "origin": "foreman"
    },
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "No rights",
      "id": 10,
      "description": null,
      "origin": ""
    },
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "Organization admin",
      "id": 13,
      "description": null,
      "origin": "foreman"
    },
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "System admin",
      "id": 14,
      "description": null,
      "origin": "foreman"
    },
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "View compute resources",
      "id": 11,
      "description": null,
      "origin": ""
    },
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "Viewer",
      "id": 5,
      "description": null,
      "origin": "foreman"
    },
    {
      "builtin": 0,
      "cloned_from_id": null,
      "name": "View hosts",
      "id": 3,
      "description": null,
      "origin": "foreman"
    }
  ]
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
search optional	filter results Validations: Must be a String
order optional	Sort field and order, eg. ‘id DESC’ Validations: Must be a String
page optional	Page number, starting at 1 Validations: Must be a number.
per_page optional	Number of results per page to return, ‘all’ to return all results Validations: Must match regular expression `/\A([1-9]\d\|all)\Z$/`.

Search fields

Field name	Type	Possible values
builtin		true, false
description	text
name	string
permission	string

Examples

GET /api/roles/1-Manager
200
{
  "builtin": 0,
  "cloned_from_id": null,
  "name": "Manager",
  "id": 1,
  "description": null,
  "origin": "foreman",
  "filters": [
    {
      "id": 139728896
    },
    {
      "id": 169533705
    },
    {
      "id": 170801529
    },
    {
      "id": 222559602
    },
    {
      "id": 225912082
    },
    {
      "id": 255448041
    },
    {
      "id": 291325508
    },
    {
      "id": 321349837
    },
    {
      "id": 340438230
    },
    {
      "id": 343831726
    },
    {
      "id": 372277853
    },
    {
      "id": 503111935
    },
    {
      "id": 528928374
    },
    {
      "id": 557298380
    },
    {
      "id": 595149887
    },
    {
      "id": 643462867
    },
    {
      "id": 679608033
    },
    {
      "id": 721145960
    },
    {
      "id": 943645556
    },
    {
      "id": 977587707
    },
    {
      "id": 980424071
    },
    {
      "id": 1025364382
    },
    {
      "id": 1026099682
    },
    {
      "id": 1062414187
    }
  ],
  "locations": [],
  "organizations": []
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
description optional	Validations: Must be a String

Examples

POST /api/roles
{
  "role": {
    "name": "staff",
    "organizations": [],
    "locations": []
  }
}
201
{
  "builtin": 0,
  "cloned_from_id": null,
  "name": "staff",
  "id": 23,
  "description": null,
  "origin": null,
  "filters": [],
  "locations": [],
  "organizations": []
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
role required	Validations: Must be a Hash
role[name] required	Validations: Must be a String
role[description] optional , nil allowed	Role description Validations: Must be a String
role[location_ids] optional , nil allowed	REPLACE locations with given ids Validations: Must be an array of any type
role[organization_ids] optional , nil allowed	REPLACE organizations with given ids. Validations: Must be an array of any type

Examples

PUT /api/roles/8-Destroy%20hosts
{
  "role": {
    "name": "staff"
  }
}
200
{
  "builtin": 0,
  "cloned_from_id": null,
  "name": "staff",
  "id": 8,
  "description": null,
  "origin": "",
  "filters": [
    {
      "id": 10997177
    }
  ],
  "locations": [],
  "organizations": []
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
id required	Validations: Must be a String
role required	Validations: Must be a Hash
role[name] optional	Validations: Must be a String
role[description] optional , nil allowed	Role description Validations: Must be a String
role[location_ids] optional , nil allowed	REPLACE locations with given ids Validations: Must be an array of any type
role[organization_ids] optional , nil allowed	REPLACE organizations with given ids. Validations: Must be an array of any type

Examples

DELETE /api/roles/8-Destroy%20hosts
{
  "role": {}
}
200
{
  "id": 8,
  "name": "Destroy hosts",
  "builtin": 0,
  "description": null,
  "origin": "",
  "cloned_from_id": null
}

Params

Param name

Description

location_id
optional

Set the current location context for the request

Validations:

Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

Must be a Integer

id
required

Validations:

Must be a String

Examples

POST /api/roles/29/clone
{
  "name": "New Role",
  "role": {
    "description": "updated description",
    "organization_ids": [
      61304186
    ],
    "name": "New Role"
  }
}
201
{
  "id": 30,
  "name": "New Role",
  "builtin": 0,
  "description": "updated description",
  "origin": null,
  "cloned_from_id": 29
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
id required	Validations: Must be a String
role required	Validations: Must be a Hash
role[name] optional	Validations: Must be a String
role[description] optional , nil allowed	Role description Validations: Must be a String
role[location_ids] optional , nil allowed	REPLACE locations with given ids Validations: Must be an array of any type
role[organization_ids] optional , nil allowed	REPLACE organizations with given ids. Validations: Must be an array of any type

Roles

GET /api/roles
List all roles

Examples

Params

Search fields

GET /api/roles/:id
Show a role

Examples

Params

POST /api/roles
Create a role

Examples

Params

PUT /api/roles/:id
Update a role

Examples

Params

DELETE /api/roles/:id
Delete a role

Examples

Params

POST /api/roles/:id/clone
Clone a role

Examples

Params

Roles

GET /api/roles List all roles

Examples

Params

Search fields

GET /api/roles/:id Show a role

Examples

Params

POST /api/roles Create a role

Examples

Params

PUT /api/roles/:id Update a role

Examples

Params

DELETE /api/roles/:id Delete a role

Examples

Params

POST /api/roles/:id/clone Clone a role

Examples

Params

GET /api/roles
List all roles

GET /api/roles/:id
Show a role

POST /api/roles
Create a role

PUT /api/roles/:id
Update a role

DELETE /api/roles/:id
Delete a role

POST /api/roles/:id/clone
Clone a role