Bookmarks

>>>

GET /api/bookmarks
List all bookmarks

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
controller string
name string
>>>

GET /api/bookmarks/:id
Show a bookmark

Examples

GET /api/bookmarks/980190962-foo
200
{
  "name": "foo",
  "controller": "hosts",
  "query": "foo=boo",
  "public": true,
  "id": 980190962,
  "owner_id": null,
  "owner_type": 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 an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /api/bookmarks
Create a bookmark

Examples

POST /api/bookmarks
{
  "bookmark": {
    "public": false,
    "controller": "hosts",
    "name": "foo-bar",
    "query": "bar"
  }
}
201
{
  "name": "foo-bar",
  "controller": "hosts",
  "query": "bar",
  "public": false,
  "id": 980190963,
  "owner_id": 135138680,
  "owner_type": "User"
}

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
bookmark
required

Validations:

  • Must be a Hash
bookmark[name]
required

Validations:

  • Must be a String
bookmark[controller]
required

Validations:

  • Must be a String
bookmark[query]
required

Validations:

  • Must be a String
bookmark[public]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
>>>

PUT /api/bookmarks/:id
Update a bookmark

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.
bookmark
required

Validations:

  • Must be a Hash
bookmark[name]
optional

Validations:

  • Must be a String
bookmark[controller]
optional

Validations:

  • Must be a String
bookmark[query]
optional

Validations:

  • Must be a String
bookmark[public]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
>>>

DELETE /api/bookmarks/:id
Delete a bookmark

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.