Smart proxies

>>>

GET /api/smart_proxies
List all smart proxies

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer
organization_id
optional

Scope by organizations

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • 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$/.
include_status
optional

Flag to indicate whether to include status or not

Validations:

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

Search fields

Field name Type Possible values
feature string
id integer
location string
location_id integer
name string
organization string
organization_id integer
url string
>>>

GET /api/smart_proxies/:id
Show a smart proxy

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
include_status
optional

Flag to indicate whether to include status or not

Validations:

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

Flag to indicate whether to include version or not

Validations:

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

POST /api/smart_proxies
Create a smart proxy

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
smart_proxy
required

Validations:

  • Hash
smart_proxy[name]
required

Validations:

  • String
smart_proxy[url]
required

Validations:

  • String
smart_proxy[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
smart_proxy[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
smart_proxy[download_policy]
optional

Download Policy of the capsule, must be one of on_demand, immediate, inherit, streamed

Validations:

  • String
smart_proxy[http_proxy_id]
optional

Id of the HTTP proxy to use with alternate content sources

Validations:

  • Integer
>>>

PUT /api/smart_proxies/:id
Update a smart proxy

Examples

PUT /api/smart_proxies/982965276
{
  "smart_proxy": {
    "http_proxy_id": 326090511,
    "name": "foobar",
    "download_policy": "immediate"
  }
}
200
{
  "created_at": "2022-11-08 19:31:33 UTC",
  "updated_at": "2022-11-08 19:31:33 UTC",
  "hosts_count": 0,
  "name": "foobar",
  "id": 982965276,
  "url": "https://somewhere21.net:8443",
  "remote_execution_pubkey": null,
  "download_policy": "immediate",
  "supported_pulp_types": [],
  "lifecycle_environments": [
    {
      "id": 562075838,
      "name": "Library",
      "description": "This is the Library",
      "library": true,
      "organization_id": 114267492,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "library_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": null,
      "prior_id": null,
      "organization": "Empty Organization"
    },
    {
      "id": 292811013,
      "name": "Dev",
      "description": "Dev environment.",
      "library": false,
      "organization_id": 114267492,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "dev_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": "Library",
      "prior_id": 562075838,
      "organization": "Empty Organization"
    },
    {
      "id": 411008527,
      "name": "Test_env",
      "description": "Test environment.",
      "library": false,
      "organization_id": 114267492,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "test_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": "Dev",
      "prior_id": 292811013,
      "organization": "Empty Organization"
    },
    {
      "id": 261162085,
      "name": "Beta",
      "description": "Beta environment.",
      "library": false,
      "organization_id": 114267492,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "beta_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": "Test_env",
      "prior_id": 411008527,
      "organization": "Empty Organization"
    },
    {
      "id": 1028819239,
      "name": "Staging",
      "description": "Staging environment.",
      "library": false,
      "organization_id": 114267492,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "staging_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": "Library",
      "prior_id": 562075838,
      "organization": "Empty Organization"
    },
    {
      "id": 396772849,
      "name": "Library",
      "description": "This is the Library",
      "library": true,
      "organization_id": 61304186,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "candlepin_library",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": null,
      "prior_id": null,
      "organization": "Organization 2"
    },
    {
      "id": 797271385,
      "name": "Candlepin Dev",
      "description": "Dev environment.",
      "library": false,
      "organization_id": 61304186,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "candlepin_dev_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": "Library",
      "prior_id": 396772849,
      "organization": "Organization 2"
    },
    {
      "id": 779215191,
      "name": "Library",
      "description": "This is the Library",
      "library": true,
      "organization_id": 447626438,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "organization1_library",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": null,
      "prior_id": null,
      "organization": "Organization 1"
    },
    {
      "id": 413623389,
      "name": "Dev Path1",
      "description": "Dev environment.",
      "library": false,
      "organization_id": 114267492,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "dev_path1_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": "Library",
      "prior_id": 562075838,
      "organization": "Empty Organization"
    },
    {
      "id": 9167524,
      "name": "QA Path1",
      "description": "QA environment.",
      "library": false,
      "organization_id": 114267492,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "qa_path1_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": "Dev Path1",
      "prior_id": 413623389,
      "organization": "Empty Organization"
    },
    {
      "id": 507881024,
      "name": "Staging Path1",
      "description": "Staging environment.",
      "library": false,
      "organization_id": 114267492,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "staging_path1_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": "QA Path1",
      "prior_id": 9167524,
      "organization": "Empty Organization"
    },
    {
      "id": 28194273,
      "name": "Dev Path2",
      "description": "Dev environment.",
      "library": false,
      "organization_id": 114267492,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "dev_path2_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": "Library",
      "prior_id": 562075838,
      "organization": "Empty Organization"
    },
    {
      "id": 427995936,
      "name": "QA Path2",
      "description": "QA environment.",
      "library": false,
      "organization_id": 114267492,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "qa_path2_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": "Dev Path2",
      "prior_id": 28194273,
      "organization": "Empty Organization"
    },
    {
      "id": 122484616,
      "name": "Staging Path2",
      "description": "Staging environment.",
      "library": false,
      "organization_id": 114267492,
      "created_at": "2022-11-08 19:09:32 UTC",
      "updated_at": "2022-11-08 19:09:32 UTC",
      "label": "staging_path2_label",
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "prior": "QA Path2",
      "prior_id": 427995936,
      "organization": "Empty Organization"
    }
  ],
  "features": [
    {
      "capabilities": [],
      "name": "Pulp",
      "id": 17596590
    },
    {
      "capabilities": [],
      "name": "Pulpcore",
      "id": 990889162
    },
    {
      "capabilities": [],
      "name": "DNS",
      "id": 49142851
    },
    {
      "capabilities": [],
      "name": "TFTP",
      "id": 303403661
    },
    {
      "capabilities": [
        "dhcp_filename_hostname",
        "dhcp_filename_ipv4"
      ],
      "name": "DHCP",
      "id": 219245707
    },
    {
      "capabilities": [],
      "name": "Puppet CA",
      "id": 783807086
    },
    {
      "capabilities": [],
      "name": "Puppet",
      "id": 1006510553
    },
    {
      "capabilities": [],
      "name": "BMC",
      "id": 821748566
    },
    {
      "capabilities": [],
      "name": "Chef Proxy",
      "id": 848995175
    },
    {
      "capabilities": [],
      "name": "Realm",
      "id": 982965213
    },
    {
      "capabilities": [],
      "name": "Logs",
      "id": 814728799
    },
    {
      "capabilities": [],
      "name": "Pulpcore",
      "id": 990889162
    },
    {
      "capabilities": [],
      "name": "Pulp",
      "id": 17596590
    },
    {
      "capabilities": [],
      "name": "DNS",
      "id": 49142851
    },
    {
      "capabilities": [],
      "name": "TFTP",
      "id": 303403661
    },
    {
      "capabilities": [
        "dhcp_filename_hostname",
        "dhcp_filename_ipv4"
      ],
      "name": "DHCP",
      "id": 219245707
    },
    {
      "capabilities": [],
      "name": "Puppet CA",
      "id": 783807086
    },
    {
      "capabilities": [],
      "name": "Puppet",
      "id": 1006510553
    },
    {
      "capabilities": [],
      "name": "BMC",
      "id": 821748566
    },
    {
      "capabilities": [],
      "name": "Chef Proxy",
      "id": 848995175
    },
    {
      "capabilities": [],
      "name": "Realm",
      "id": 982965213
    },
    {
      "capabilities": [],
      "name": "Logs",
      "id": 814728799
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 114267492,
      "name": "Empty Organization",
      "title": "Empty Organization",
      "description": null
    },
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    },
    {
      "id": 61304186,
      "name": "Organization 2",
      "title": "Organization 2",
      "description": null
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
smart_proxy
required

Validations:

  • Hash
smart_proxy[name]
optional

Validations:

  • String
smart_proxy[url]
optional

Validations:

  • String
smart_proxy[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
smart_proxy[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
smart_proxy[download_policy]
optional

Download Policy of the capsule, must be one of on_demand, immediate, inherit, streamed

Validations:

  • String
smart_proxy[http_proxy_id]
optional

Id of the HTTP proxy to use with alternate content sources

Validations:

  • Integer
>>>

DELETE /api/smart_proxies/:id
Delete a smart proxy

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
>>>

PUT /api/smart_proxies/:id/refresh
Refresh smart proxy features

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
>>>

POST /api/smart_proxies/:id/import_subnets
Import subnets from Smart proxy

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String