Content_exports

>>>

GET /katello/api/content_exports
List export histories

Examples

GET /katello/api/content_exports
200
{
  "total": 2,
  "subtotal": 2,
  "selectable": 2,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "id",
    "order": "asc"
  },
  "results": [
    {
      "destination_server": "lovely.example.com",
      "path": "/tmp/lovely",
      "id": 581409183,
      "metadata": {},
      "type": "incremental",
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "content_view_version": "Published LIbrary view 1.0",
      "content_view_version_id": 531274492
    },
    {
      "destination_server": "perfect.example.com",
      "path": "/tmp/perfect",
      "id": 624072441,
      "metadata": {},
      "type": "complete",
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "content_view_version": "Published LIbrary view 1.0",
      "content_view_version_id": 531274492
    }
  ]
}

Params

Param name Description
content_view_version_id
optional

Content view version identifier

Validations:

  • Must be a number.
content_view_id
optional

Content view identifier

Validations:

  • Must be a number.
destination_server
optional

Destination Server name

Validations:

  • String
organization_id
optional

Organization identifier

Validations:

  • Must be a number.
id
optional

Content view version export history identifier

Validations:

  • Must be a number.
type
optional

Export Types

Validations:

  • Must be one of: complete, incremental.
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
content_view_id integer
content_view_version_id integer
id integer
type string
>>>

POST /katello/api/content_exports/version
Performs a full-export of a content view version.

Examples

POST /katello/api/content_exports/version
{
  "id": 234564707,
  "destination_server": "example.com",
  "chunk_size_gb": 100,
  "fail_on_missing_content": true,
  "content_export": {
    "id": 234564707,
    "destination_server": "example.com",
    "chunk_size_gb": 100,
    "fail_on_missing_content": true
  }
}
202
{
  "id": null,
  "label": null,
  "pending": null,
  "username": null,
  "started_at": null,
  "ended_at": null,
  "state": null,
  "result": null,
  "progress": null,
  "input": null,
  "output": {},
  "humanized": null,
  "cli_example": null,
  "available_actions": {
    "cancellable": null,
    "resumable": null
  }
}

Params

Param name Description
id
required

Content view version identifier

Validations:

  • Must be a number.
fail_on_missing_content
optional

Fails if any of the repositories belonging to this version are unexportable. False by default.

Validations:

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

Destination Server name

Validations:

  • String
chunk_size_gb
optional

Split the exported content into archives no greater than the specified size in gigabytes.

Validations:

  • Must be a number.
format
optional

Export formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker repositories.

Validations:

  • Must be one of: syncable, importable.
>>>

POST /katello/api/content_exports/library
Performs a full-export of the repositories in library.

Examples

POST /katello/api/content_exports/library
{
  "organization_id": 114267492,
  "destination_server": "example.com",
  "chunk_size_gb": 100,
  "content_export": {
    "organization_id": 114267492,
    "destination_server": "example.com",
    "chunk_size_gb": 100
  }
}
202
{
  "id": null,
  "label": null,
  "pending": null,
  "username": null,
  "started_at": null,
  "ended_at": null,
  "state": null,
  "result": null,
  "progress": null,
  "input": null,
  "output": {},
  "humanized": null,
  "cli_example": null,
  "available_actions": {
    "cancellable": null,
    "resumable": null
  }
}

Params

Param name Description
organization_id
required

Organization identifier

Validations:

  • Must be a number.
fail_on_missing_content
optional

Fails if any of the repositories belonging to this organization are unexportable. False by default.

Validations:

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

Destination Server name

Validations:

  • String
chunk_size_gb
optional

Split the exported content into archives no greater than the specified size in gigabytes.

Validations:

  • Must be a number.
format
optional

Export formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker repositories.

Validations:

  • Must be one of: syncable, importable.
>>>

POST /katello/api/content_exports/repository
Performs a full-export of the repository in library.

Params

Param name Description
id
required

Repository identifier

Validations:

  • Must be a number.
chunk_size_gb
optional

Split the exported content into archives no greater than the specified size in gigabytes.

Validations:

  • Must be a number.
format
optional

Export formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker repositories.

Validations:

  • Must be one of: syncable, importable.