Description

Documents the calls for the list, read, create, update and delete operations for GPG keys


GET /katello/api/gpg_keys
List gpg keys

Params

Param name Description
organization_id
required

organization identifier

Validations:

  • number.

name
optional

name of the GPG key

Validations:

  • String

search
optional

Search string

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • number.

per_page
optional

Number of results per page to return

Validations:

  • number.

order
optional

Sort field and order, eg. ‘name DESC’

Validations:

  • String

full_result
optional

Whether or not to show all results

Validations:

  • boolean

sort
optional

Hash version of ‘order’ param

Validations:

  • Hash

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


POST /katello/api/gpg_keys
Create a gpg key

Params

Param name Description
organization_id
required

organization identifier

Validations:

  • number.

name
required

identifier of the gpg key

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

content
required

public key block in DER encoding

Validations:

  • String


GET /katello/api/gpg_keys/:id
Show a gpg key

Params

Param name Description
id
required

gpg key numeric identifier

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


PUT /katello/api/gpg_keys/:id
Update a repository

Params

Param name Description
id
required

gpg key numeric identifier

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

name
optional

identifier of the gpg key

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

content
optional

public key block in DER encoding

Validations:

  • String


DELETE /katello/api/gpg_keys/:id
Destroy a gpg key

Params

Param name Description
id
required

gpg key numeric identifier

Validations:

  • number.


POST /katello/api/gpg_keys/:id/content
Upload gpg key contents

Params

Param name Description
id
required

gpg key numeric identifier

Validations:

  • number.

content
required

file contents

Validations:

  • File