Examples

GET /katello/api/organizations/114267492/activation_keys
200
{
  "total": 5,
  "subtotal": 5,
  "selectable": 5,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "id": 757667888,
      "name": "Activation Key",
      "description": "A simple activation key.",
      "unlimited_hosts": true,
      "auto_attach": true,
      "content_view_id": 30237652,
      "environment_id": 562075838,
      "usage_count": 0,
      "user_id": null,
      "max_hosts": null,
      "release_version": "7Server",
      "purpose_usage": "usage name",
      "purpose_role": "role name",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-02-22 18:22:29 UTC",
      "updated_at": "2024-02-22 18:22:29 UTC",
      "content_view": {
        "id": 30237652,
        "name": "ACME Default ContentView"
      },
      "environment": {
        "name": "Library",
        "id": 562075838
      },
      "products": [
        {
          "id": 785257261,
          "name": "Fedora"
        }
      ],
      "host_collections": [],
      "purpose_addons": [
        "Test Addon"
      ],
      "permissions": {
        "view_activation_keys": true,
        "edit_activation_keys": true,
        "destroy_activation_keys": true
      }
    },
    {
      "id": 939253911,
      "name": "And Yet Another Simple Activation Key",
      "description": "Here we go again!",
      "unlimited_hosts": true,
      "auto_attach": true,
      "content_view_id": 30237652,
      "environment_id": 562075838,
      "usage_count": 0,
      "user_id": null,
      "max_hosts": null,
      "release_version": null,
      "purpose_usage": null,
      "purpose_role": null,
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-02-22 18:22:29 UTC",
      "updated_at": "2024-02-22 18:22:29 UTC",
      "content_view": {
        "id": 30237652,
        "name": "ACME Default ContentView"
      },
      "environment": {
        "name": "Library",
        "id": 562075838
      },
      "products": [
        {
          "id": 785257261,
          "name": "Fedora"
        }
      ],
      "host_collections": [],
      "purpose_addons": [],
      "permissions": {
        "view_activation_keys": true,
        "edit_activation_keys": true,
        "destroy_activation_keys": true
      }
    },
    {
      "id": 734311356,
      "name": "Another Simple Activation Key",
      "description": "Another simple activation key.",
      "unlimited_hosts": true,
      "auto_attach": true,
      "content_view_id": 30237652,
      "environment_id": 562075838,
      "usage_count": 0,
      "user_id": null,
      "max_hosts": null,
      "release_version": null,
      "purpose_usage": null,
      "purpose_role": null,
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-02-22 18:22:29 UTC",
      "updated_at": "2024-02-22 18:22:29 UTC",
      "content_view": {
        "id": 30237652,
        "name": "ACME Default ContentView"
      },
      "environment": {
        "name": "Library",
        "id": 562075838
      },
      "products": [
        {
          "id": 785257261,
          "name": "Fedora"
        }
      ],
      "host_collections": [],
      "purpose_addons": [],
      "permissions": {
        "view_activation_keys": true,
        "edit_activation_keys": true,
        "destroy_activation_keys": true
      }
    },
    {
      "id": 568942081,
      "name": "Simple Activation Key",
      "description": "A simple activation key.",
      "unlimited_hosts": true,
      "auto_attach": true,
      "content_view_id": 30237652,
      "environment_id": 562075838,
      "usage_count": 0,
      "user_id": null,
      "max_hosts": null,
      "release_version": null,
      "purpose_usage": null,
      "purpose_role": null,
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-02-22 18:22:29 UTC",
      "updated_at": "2024-02-22 18:22:29 UTC",
      "content_view": {
        "id": 30237652,
        "name": "ACME Default ContentView"
      },
      "environment": {
        "name": "Library",
        "id": 562075838
      },
      "products": [
        {
          "id": 785257261,
          "name": "Fedora"
        }
      ],
      "host_collections": [],
      "purpose_addons": [],
      "permissions": {
        "view_activation_keys": true,
        "edit_activation_keys": true,
        "destroy_activation_keys": true
      }
    },
    {
      "id": 323709460,
      "name": "Yet Another Activation Key",
      "description": "And another simple activation key!",
      "unlimited_hosts": true,
      "auto_attach": true,
      "content_view_id": 30237652,
      "environment_id": 562075838,
      "usage_count": 0,
      "user_id": null,
      "max_hosts": null,
      "release_version": null,
      "purpose_usage": null,
      "purpose_role": null,
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-02-22 18:22:29 UTC",
      "updated_at": "2024-02-22 18:22:29 UTC",
      "content_view": {
        "id": 30237652,
        "name": "ACME Default ContentView"
      },
      "environment": {
        "name": "Library",
        "id": 562075838
      },
      "products": [
        {
          "id": 785257261,
          "name": "Fedora"
        }
      ],
      "host_collections": [],
      "purpose_addons": [],
      "permissions": {
        "view_activation_keys": true,
        "edit_activation_keys": true,
        "destroy_activation_keys": true
      }
    }
  ]
}

Params

Param name Description
organization_id
required

organization identifier

Validations:

  • Must be a number.

environment_id
optional

environment identifier

Validations:

  • Must be a number.

content_view_id
optional

content view identifier

Validations:

  • Must be a number.

name
optional

activation key name to filter by

Validations:

  • String

search
optional

Search string

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return

Validations:

  • Must be a number.

order
optional

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
optional

Whether or not to show all results

Validations:

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

sort_by
optional

Field to sort the results on

Validations:

  • String

sort_order
optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String

Search fields

Field name Type Possible values
addon string
content_view string
content_view_id integer
description text
environment string
name string
organization_id integer
role string
subscription_id string
subscription_name string
usage string