GET /api/filters
List all filters

Examples

GET /api/filters
200
{
  "total": 63,
  "subtotal": 63,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "search": null,
      "resource_type": "Parameter",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 1673117,
      "role": {
        "name": "Viewer",
        "id": 5,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "view_params",
          "id": 185756810,
          "resource_type": "Parameter"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Host",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 10997177,
      "role": {
        "name": "Destroy hosts",
        "id": 8,
        "description": null,
        "origin": ""
      },
      "permissions": [
        {
          "name": "destroy_hosts",
          "id": 619977594,
          "resource_type": "Host"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "User",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 32424218,
      "role": {
        "name": "System admin",
        "id": 14,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "create_users",
          "id": 544005512,
          "resource_type": "User"
        },
        {
          "name": "view_users",
          "id": 916456187,
          "resource_type": "User"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Operatingsystem",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 39285100,
      "role": {
        "name": "Viewer",
        "id": 5,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "view_operatingsystems",
          "id": 940057595,
          "resource_type": "Operatingsystem"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Host",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 87733621,
      "role": {
        "name": "Viewer",
        "id": 5,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "view_hosts",
          "id": 988725676,
          "resource_type": "Host"
        }
      ]
    },
    {
      "search": null,
      "resource_type": null,
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 98755168,
      "role": {
        "name": "Viewer",
        "id": 5,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "view_statistics",
          "id": 955233873,
          "resource_type": null
        },
        {
          "name": "access_settings",
          "id": 139485686,
          "resource_type": null
        },
        {
          "name": "access_dashboard",
          "id": 220719619,
          "resource_type": null
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Host",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 101507509,
      "role": {
        "name": "Edit hosts",
        "id": 4,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "edit_hosts",
          "id": 561976263,
          "resource_type": "Host"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Organization",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 109249809,
      "role": {
        "name": "System admin",
        "id": 14,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "edit_organizations",
          "id": 810159931,
          "resource_type": "Organization"
        },
        {
          "name": "assign_organizations",
          "id": 955375685,
          "resource_type": "Organization"
        },
        {
          "name": "create_organizations",
          "id": 839488775,
          "resource_type": "Organization"
        },
        {
          "name": "destroy_organizations",
          "id": 647541143,
          "resource_type": "Organization"
        },
        {
          "name": "view_organizations",
          "id": 277779683,
          "resource_type": "Organization"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Ptable",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 139728896,
      "role": {
        "name": "Manager",
        "id": 1,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "destroy_ptables",
          "id": 953432930,
          "resource_type": "Ptable"
        },
        {
          "name": "view_ptables",
          "id": 769440046,
          "resource_type": "Ptable"
        },
        {
          "name": "create_ptables",
          "id": 649673681,
          "resource_type": "Ptable"
        },
        {
          "name": "edit_ptables",
          "id": 1048516464,
          "resource_type": "Ptable"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Subnet",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 169533705,
      "role": {
        "name": "Manager",
        "id": 1,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "view_subnets",
          "id": 102149605,
          "resource_type": "Subnet"
        },
        {
          "name": "destroy_subnets",
          "id": 320745391,
          "resource_type": "Subnet"
        },
        {
          "name": "edit_subnets",
          "id": 364184483,
          "resource_type": "Subnet"
        },
        {
          "name": "create_subnets",
          "id": 225652514,
          "resource_type": "Subnet"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "AuthSource",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 170801529,
      "role": {
        "name": "Manager",
        "id": 1,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "create_authenticators",
          "id": 956119309,
          "resource_type": "AuthSource"
        },
        {
          "name": "edit_authenticators",
          "id": 395314704,
          "resource_type": "AuthSource"
        },
        {
          "name": "destroy_authenticators",
          "id": 1067518973,
          "resource_type": "AuthSource"
        },
        {
          "name": "view_authenticators",
          "id": 687843582,
          "resource_type": "AuthSource"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Organization",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 199310663,
      "role": {
        "name": "Viewer",
        "id": 5,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "view_organizations",
          "id": 277779683,
          "resource_type": "Organization"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "FactValue",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 206876277,
      "role": {
        "name": "Viewer",
        "id": 5,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "view_facts",
          "id": 958901131,
          "resource_type": "FactValue"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "CommonParameter",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 222559602,
      "role": {
        "name": "Manager",
        "id": 1,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "create_globals",
          "id": 225414942,
          "resource_type": "CommonParameter"
        },
        {
          "name": "edit_globals",
          "id": 363439011,
          "resource_type": "CommonParameter"
        },
        {
          "name": "destroy_globals",
          "id": 318934959,
          "resource_type": "CommonParameter"
        },
        {
          "name": "view_globals",
          "id": 101322209,
          "resource_type": "CommonParameter"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Location",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 225912082,
      "role": {
        "name": "Manager",
        "id": 1,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "view_locations",
          "id": 342396477,
          "resource_type": "Location"
        },
        {
          "name": "destroy_locations",
          "id": 302614650,
          "resource_type": "Location"
        },
        {
          "name": "create_locations",
          "id": 919402658,
          "resource_type": "Location"
        },
        {
          "name": "edit_locations",
          "id": 360701043,
          "resource_type": "Location"
        }
      ]
    },
    {
      "search": null,
      "resource_type": null,
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 255448041,
      "role": {
        "name": "Manager",
        "id": 1,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "access_settings",
          "id": 139485686,
          "resource_type": null
        },
        {
          "name": "access_dashboard",
          "id": 220719619,
          "resource_type": null
        },
        {
          "name": "view_statistics",
          "id": 955233873,
          "resource_type": null
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Operatingsystem",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 291325508,
      "role": {
        "name": "Manager",
        "id": 1,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "destroy_operatingsystems",
          "id": 936871672,
          "resource_type": "Operatingsystem"
        },
        {
          "name": "view_operatingsystems",
          "id": 940057595,
          "resource_type": "Operatingsystem"
        },
        {
          "name": "create_operatingsystems",
          "id": 1038489107,
          "resource_type": "Operatingsystem"
        },
        {
          "name": "edit_operatingsystems",
          "id": 887912542,
          "resource_type": "Operatingsystem"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Architecture",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 321349837,
      "role": {
        "name": "Manager",
        "id": 1,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "create_architectures",
          "id": 912770095,
          "resource_type": "Architecture"
        },
        {
          "name": "edit_architectures",
          "id": 874798611,
          "resource_type": "Architecture"
        },
        {
          "name": "destroy_architectures",
          "id": 586604735,
          "resource_type": "Architecture"
        },
        {
          "name": "view_architectures",
          "id": 350275019,
          "resource_type": "Architecture"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Domain",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 340438230,
      "role": {
        "name": "Manager",
        "id": 1,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "create_domains",
          "id": 776153244,
          "resource_type": "Domain"
        },
        {
          "name": "edit_domains",
          "id": 914687015,
          "resource_type": "Domain"
        },
        {
          "name": "destroy_domains",
          "id": 808331307,
          "resource_type": "Domain"
        },
        {
          "name": "view_domains",
          "id": 623290985,
          "resource_type": "Domain"
        }
      ]
    },
    {
      "search": null,
      "resource_type": "Realm",
      "unlimited?": true,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "override?": false,
      "id": 343831726,
      "role": {
        "name": "Manager",
        "id": 1,
        "description": null,
        "origin": "foreman"
      },
      "permissions": [
        {
          "name": "view_realms",
          "id": 959316070,
          "resource_type": "Realm"
        },
        {
          "name": "destroy_realms",
          "id": 300788035,
          "resource_type": "Realm"
        },
        {
          "name": "edit_realms",
          "id": 327146991,
          "resource_type": "Realm"
        },
        {
          "name": "create_realms",
          "id": 125033645,
          "resource_type": "Realm"
        }
      ]
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

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

paginate results

Validations:

  • Must be a String

per_page
optional

number of entries per request

Validations:

  • Must be a String

Search fields

Field name Type Possible values
limited true, false
location string
location_id integer
organization string
organization_id integer
override true, false
permission string
resource string
role string
role_id integer
search text
unlimited true, false

GET /api/filters/:id
Show a filter

Examples

GET /api/filters/321349837
200
{
  "search": null,
  "resource_type": "Architecture",
  "unlimited?": true,
  "created_at": "2018-11-15 19:01:27 UTC",
  "updated_at": "2018-11-15 19:01:27 UTC",
  "override?": false,
  "id": 321349837,
  "role": {
    "name": "Manager",
    "id": 1,
    "description": null,
    "origin": "foreman"
  },
  "permissions": [
    {
      "name": "create_architectures",
      "id": 912770095,
      "resource_type": "Architecture"
    },
    {
      "name": "edit_architectures",
      "id": 874798611,
      "resource_type": "Architecture"
    },
    {
      "name": "destroy_architectures",
      "id": 586604735,
      "resource_type": "Architecture"
    },
    {
      "name": "view_architectures",
      "id": 350275019,
      "resource_type": "Architecture"
    }
  ],
  "locations": [],
  "organizations": []
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

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/filters
Create a filter

Examples

POST /api/filters
{
  "filter": {
    "role_id": 8,
    "permission_ids": [
      350275019
    ]
  }
}
201
{
  "search": null,
  "resource_type": "Architecture",
  "unlimited?": true,
  "created_at": "2018-11-15 19:01:35 UTC",
  "updated_at": "2018-11-15 19:01:35 UTC",
  "override?": false,
  "id": 1062414301,
  "role": {
    "name": "Destroy hosts",
    "id": 8,
    "description": null,
    "origin": ""
  },
  "permissions": [
    {
      "name": "view_architectures",
      "id": 350275019,
      "resource_type": "Architecture"
    }
  ],
  "locations": [],
  "organizations": []
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

filter
required

Validations:

  • Must be a Hash

filter[role_id]
required

Validations:

  • Must be a String

filter[search]
optional , nil allowed

Validations:

  • Must be a String

filter[override]
optional , nil allowed

Validations:

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

filter[permission_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

filter[organization_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

filter[location_ids]
optional , nil allowed

Validations:

  • Must be an array of any type


PUT /api/filters/:id
Update a filter

Examples

PUT /api/filters/10997177
{
  "filter": {
    "role_id": 8,
    "permission_ids": [
      740433627
    ]
  }
}
200
{
  "search": null,
  "resource_type": "Host",
  "unlimited?": true,
  "created_at": "2018-11-15 19:01:27 UTC",
  "updated_at": "2018-11-15 19:01:27 UTC",
  "override?": false,
  "id": 10997177,
  "role": {
    "name": "Destroy hosts",
    "id": 8,
    "description": null,
    "origin": ""
  },
  "permissions": [
    {
      "name": "create_hosts",
      "id": 740433627,
      "resource_type": "Host"
    }
  ],
  "locations": [],
  "organizations": []
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be a String

filter
required

Validations:

  • Must be a Hash

filter[role_id]
optional

Validations:

  • Must be a String

filter[search]
optional , nil allowed

Validations:

  • Must be a String

filter[override]
optional , nil allowed

Validations:

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

filter[permission_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

filter[organization_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

filter[location_ids]
optional , nil allowed

Validations:

  • Must be an array of any type


DELETE /api/filters/:id
Delete a filter

Examples

DELETE /api/filters/10997177
{
  "filter": {}
}
200
{
  "id": 10997177,
  "search": null,
  "role_id": 8,
  "created_at": "2018-11-15T19:01:27.704Z",
  "updated_at": "2018-11-15T19:01:27.704Z",
  "taxonomy_search": null,
  "override": false
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be a String