Bookmarks

>>>

GET /api/bookmarks
List all bookmarks

Examples

GET /api/v2/bookmarks?page=1&per_page=10&search=
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 10,
  "search": "",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "foo",
      "controller": "hosts",
      "query": "foo=boo",
      "public": true,
      "id": 980190962,
      "owner_id": null,
      "owner_type": null
    },
    {
      "name": "three",
      "controller": "hosts",
      "query": "three",
      "public": true,
      "id": 113629430,
      "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
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. '<field> 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
id integer
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": null,
    "controller": "hosts",
    "name": "foo-bar",
    "query": "bar"
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "public": [
        "is not included in the list"
      ]
    },
    "full_messages": [
      "Public is not included in the list"
    ]
  }
}

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

Examples

PUT /api/bookmarks/980190962
{
  "bookmark": {
    "public": false,
    "controller": "hosts",
    "name": "foo-bar",
    "query": ""
  }
}
422
{
  "error": {
    "id": 980190962,
    "errors": {
      "query": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Search query can't be blank"
    ]
  }
}

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

Examples

DELETE /api/bookmarks/980190962-foo
{
  "bookmark": {}
}
200
{
  "id": 980190962,
  "name": "foo",
  "query": "foo=boo",
  "controller": "hosts",
  "public": true,
  "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.