PulpCertguardClient::ContentguardsX509Api
All URIs are relative to http://localhost:24817
| Method | HTTP request | Description |
|---|---|---|
| create | POST /pulp/api/v3/contentguards/certguard/x509/ | Create a x509 cert guard |
| delete | DELETE certguard_x509_cert_guard_href | Delete a x509 cert guard |
| list | GET /pulp/api/v3/contentguards/certguard/x509/ | List x509 cert guards |
| partial_update | PATCH certguard_x509_cert_guard_href | Update a x509 cert guard |
| read | GET certguard_x509_cert_guard_href | Inspect a x509 cert guard |
| update | PUT certguard_x509_cert_guard_href | Update a x509 cert guard |
create
create(certguard_x509_cert_guard, opts)
Create a x509 cert guard
X509CertGuard API Viewsets.
Examples
require 'time'
require 'pulp_certguard_client'
# setup authorization
PulpCertguardClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = PulpCertguardClient::ContentguardsX509Api.new
certguard_x509_cert_guard = PulpCertguardClient::CertguardX509CertGuard.new({name: 'name_example', ca_certificate: 'ca_certificate_example'}) # CertguardX509CertGuard |
opts = {
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
}
begin
# Create a x509 cert guard
result = api_instance.create(certguard_x509_cert_guard, opts)
p result
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->create: #{e}"
end
Using the create_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> create_with_http_info(certguard_x509_cert_guard, opts)
begin
# Create a x509 cert guard
data, status_code, headers = api_instance.create_with_http_info(certguard_x509_cert_guard, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <CertguardX509CertGuardResponse>
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->create_with_http_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certguard_x509_cert_guard | CertguardX509CertGuard | ||
| x_task_diagnostics | Array<String> | List of profilers to use on tasks. | [optional] |
Return type
CertguardX509CertGuardResponse
Authorization
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
- Accept: application/json
delete
delete(certguard_x509_cert_guard_href, opts)
Delete a x509 cert guard
X509CertGuard API Viewsets.
Examples
require 'time'
require 'pulp_certguard_client'
# setup authorization
PulpCertguardClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = PulpCertguardClient::ContentguardsX509Api.new
certguard_x509_cert_guard_href = 'certguard_x509_cert_guard_href_example' # String |
opts = {
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
}
begin
# Delete a x509 cert guard
api_instance.delete(certguard_x509_cert_guard_href, opts)
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->delete: #{e}"
end
Using the delete_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
delete_with_http_info(certguard_x509_cert_guard_href, opts)
begin
# Delete a x509 cert guard
data, status_code, headers = api_instance.delete_with_http_info(certguard_x509_cert_guard_href, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->delete_with_http_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certguard_x509_cert_guard_href | String | ||
| x_task_diagnostics | Array<String> | List of profilers to use on tasks. | [optional] |
Return type
nil (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
list
list(opts)
List x509 cert guards
X509CertGuard API Viewsets.
Examples
require 'time'
require 'pulp_certguard_client'
# setup authorization
PulpCertguardClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = PulpCertguardClient::ContentguardsX509Api.new
opts = {
x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
limit: 56, # Integer | Number of results to return per page.
name: 'name_example', # String | Filter results where name matches value
name__contains: 'name__contains_example', # String | Filter results where name contains value
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
offset: 56, # Integer | The initial index from which to return the results.
ordering: ['-description'], # Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending)
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
}
begin
# List x509 cert guards
result = api_instance.list(opts)
p result
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->list: #{e}"
end
Using the list_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> list_with_http_info(opts)
begin
# List x509 cert guards
data, status_code, headers = api_instance.list_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <PaginatedcertguardX509CertGuardResponseList>
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->list_with_http_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| x_task_diagnostics | Array<String> | List of profilers to use on tasks. | [optional] |
| limit | Integer | Number of results to return per page. | [optional] |
| name | String | Filter results where name matches value | [optional] |
| name__contains | String | Filter results where name contains value | [optional] |
| name__icontains | String | Filter results where name contains value | [optional] |
| name__iexact | String | Filter results where name matches value | [optional] |
| name__in | Array<String> | Filter results where name is in a comma-separated list of values | [optional] |
| name__iregex | String | Filter results where name matches regex value | [optional] |
| name__istartswith | String | Filter results where name starts with value | [optional] |
| name__regex | String | Filter results where name matches regex value | [optional] |
| name__startswith | String | Filter results where name starts with value | [optional] |
| offset | Integer | The initial index from which to return the results. | [optional] |
| ordering | Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
| prn__in | Array<String> | Multiple values may be separated by commas. | [optional] |
| pulp_href__in | Array<String> | Multiple values may be separated by commas. | [optional] |
| pulp_id__in | Array<String> | Multiple values may be separated by commas. | [optional] |
| q | String | Filter results by using NOT, AND and OR operations on other filters | [optional] |
| fields | Array<String> | A list of fields to include in the response. | [optional] |
| exclude_fields | Array<String> | A list of fields to exclude from the response. | [optional] |
Return type
PaginatedcertguardX509CertGuardResponseList
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
partial_update
partial_update(certguard_x509_cert_guard_href, patchedcertguard_x509_cert_guard, opts)
Update a x509 cert guard
X509CertGuard API Viewsets.
Examples
require 'time'
require 'pulp_certguard_client'
# setup authorization
PulpCertguardClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = PulpCertguardClient::ContentguardsX509Api.new
certguard_x509_cert_guard_href = 'certguard_x509_cert_guard_href_example' # String |
patchedcertguard_x509_cert_guard = PulpCertguardClient::PatchedcertguardX509CertGuard.new # PatchedcertguardX509CertGuard |
opts = {
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
}
begin
# Update a x509 cert guard
result = api_instance.partial_update(certguard_x509_cert_guard_href, patchedcertguard_x509_cert_guard, opts)
p result
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->partial_update: #{e}"
end
Using the partial_update_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> partial_update_with_http_info(certguard_x509_cert_guard_href, patchedcertguard_x509_cert_guard, opts)
begin
# Update a x509 cert guard
data, status_code, headers = api_instance.partial_update_with_http_info(certguard_x509_cert_guard_href, patchedcertguard_x509_cert_guard, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <CertguardX509CertGuardResponse>
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->partial_update_with_http_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certguard_x509_cert_guard_href | String | ||
| patchedcertguard_x509_cert_guard | PatchedcertguardX509CertGuard | ||
| x_task_diagnostics | Array<String> | List of profilers to use on tasks. | [optional] |
Return type
CertguardX509CertGuardResponse
Authorization
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
- Accept: application/json
read
read(certguard_x509_cert_guard_href, opts)
Inspect a x509 cert guard
X509CertGuard API Viewsets.
Examples
require 'time'
require 'pulp_certguard_client'
# setup authorization
PulpCertguardClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = PulpCertguardClient::ContentguardsX509Api.new
certguard_x509_cert_guard_href = 'certguard_x509_cert_guard_href_example' # String |
opts = {
x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
}
begin
# Inspect a x509 cert guard
result = api_instance.read(certguard_x509_cert_guard_href, opts)
p result
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->read: #{e}"
end
Using the read_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> read_with_http_info(certguard_x509_cert_guard_href, opts)
begin
# Inspect a x509 cert guard
data, status_code, headers = api_instance.read_with_http_info(certguard_x509_cert_guard_href, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <CertguardX509CertGuardResponse>
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->read_with_http_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certguard_x509_cert_guard_href | String | ||
| x_task_diagnostics | Array<String> | List of profilers to use on tasks. | [optional] |
| fields | Array<String> | A list of fields to include in the response. | [optional] |
| exclude_fields | Array<String> | A list of fields to exclude from the response. | [optional] |
Return type
CertguardX509CertGuardResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
update
update(certguard_x509_cert_guard_href, certguard_x509_cert_guard, opts)
Update a x509 cert guard
X509CertGuard API Viewsets.
Examples
require 'time'
require 'pulp_certguard_client'
# setup authorization
PulpCertguardClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = PulpCertguardClient::ContentguardsX509Api.new
certguard_x509_cert_guard_href = 'certguard_x509_cert_guard_href_example' # String |
certguard_x509_cert_guard = PulpCertguardClient::CertguardX509CertGuard.new({name: 'name_example', ca_certificate: 'ca_certificate_example'}) # CertguardX509CertGuard |
opts = {
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
}
begin
# Update a x509 cert guard
result = api_instance.update(certguard_x509_cert_guard_href, certguard_x509_cert_guard, opts)
p result
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->update: #{e}"
end
Using the update_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> update_with_http_info(certguard_x509_cert_guard_href, certguard_x509_cert_guard, opts)
begin
# Update a x509 cert guard
data, status_code, headers = api_instance.update_with_http_info(certguard_x509_cert_guard_href, certguard_x509_cert_guard, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <CertguardX509CertGuardResponse>
rescue PulpCertguardClient::ApiError => e
puts "Error when calling ContentguardsX509Api->update_with_http_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certguard_x509_cert_guard_href | String | ||
| certguard_x509_cert_guard | CertguardX509CertGuard | ||
| x_task_diagnostics | Array<String> | List of profilers to use on tasks. | [optional] |
Return type
CertguardX509CertGuardResponse
Authorization
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
- Accept: application/json