Pulp 3 API

These details have not been verified by PyPI

Project description

pulpcore.client.pulp_service.ApiCreateDomainApi

All URIs are relative to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
post	POST /api/pulp/create-domain/	Create domain

post

DomainResponse post(domain, x_task_diagnostics=x_task_diagnostics)

Create domain

Create a new domain for from S3 template domain, self-service path

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.domain import Domain
from pulpcore.client.pulp_service.models.domain_response import DomainResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ApiCreateDomainApi(api_client)
    domain = pulpcore.client.pulp_service.Domain() # Domain | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create domain
        api_response = api_instance.post(domain, x_task_diagnostics=x_task_diagnostics)
        print("The response of ApiCreateDomainApi->post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiCreateDomainApi->post: %s\n" % e)

Parameters

Name	Type	Description	Notes
domain	Domain
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

DomainResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_service.ApiDebugAuthHeaderApi

All URIs are relative to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
get	GET /api/pulp/debug_auth_header/

get

get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Returns the content of the authentication headers.

Example

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)


# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ApiDebugAuthHeaderApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
    except Exception as e:
        print("Exception when calling ApiDebugAuthHeaderApi->get: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_service.ApiDebugDatabaseTriggersApi

All URIs are relative to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
get	GET /api/pulp/debug/database-triggers/

get

get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Query PostgreSQL system catalogs for triggers on core_task table.

Example

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)


# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ApiDebugDatabaseTriggersApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
    except Exception as e:
        print("Exception when calling ApiDebugDatabaseTriggersApi->get: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_service.ApiRdsConnectionTestsApi

All URIs are relative to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
get	GET /api/pulp/rds-connection-tests/
post	POST /api/pulp/rds-connection-tests/	Dispatch RDS connection tests

get

get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Get available tests and their descriptions. This endpoint is always accessible for documentation purposes.

Example

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)


# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ApiRdsConnectionTestsApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
    except Exception as e:
        print("Exception when calling ApiRdsConnectionTestsApi->get: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post

AsyncOperationResponse post(x_task_diagnostics=x_task_diagnostics)

Dispatch RDS connection tests

Dispatch RDS Proxy connection timeout tests

Example

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)


# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ApiRdsConnectionTestsApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Dispatch RDS connection tests
        api_response = api_instance.post(x_task_diagnostics=x_task_diagnostics)
        print("The response of ApiRdsConnectionTestsApi->post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiRdsConnectionTestsApi->post: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_service.ApiTestRandomLockTasksApi

All URIs are relative to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
get	GET /api/pulp/test/random_lock_tasks/

get

get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Example

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)


# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ApiTestRandomLockTasksApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
    except Exception as e:
        print("Exception when calling ApiTestRandomLockTasksApi->get: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_service.ApiTestTasksApi

All URIs are relative to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
get	GET /api/pulp/test/tasks/

get

get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Example

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)


# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ApiTestTasksApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
    except Exception as e:
        print("Exception when calling ApiTestTasksApi->get: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AsyncOperationResponse

Serializer for asynchronous operations.

Properties

Name	Type	Description	Notes
task	str	The href of the task.

Example

from pulpcore.client.pulp_service.models.async_operation_response import AsyncOperationResponse

# TODO update the JSON string below
json = "{}"
# create an instance of AsyncOperationResponse from a JSON string
async_operation_response_instance = AsyncOperationResponse.from_json(json)
# print the JSON string representation of the object
print(AsyncOperationResponse.to_json())

# convert the object into a dict
async_operation_response_dict = async_operation_response_instance.to_dict()
# create an instance of AsyncOperationResponse from a dict
async_operation_response_from_dict = AsyncOperationResponse.from_dict(async_operation_response_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_service.ContentguardsFeatureApi

All URIs are relative to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
add_role	POST {service_feature_content_guard_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/contentguards/service/feature/	Create a feature content guard
delete	DELETE {service_feature_content_guard_href}	Delete a feature content guard
list	GET /api/pulp/{pulp_domain}/api/v3/contentguards/service/feature/	List feature content guards
list_roles	GET {service_feature_content_guard_href}list_roles/	List roles
my_permissions	GET {service_feature_content_guard_href}my_permissions/	List user permissions
partial_update	PATCH {service_feature_content_guard_href}	Update a feature content guard
read	GET {service_feature_content_guard_href}	Inspect a feature content guard
remove_role	POST {service_feature_content_guard_href}remove_role/	Remove a role
update	PUT {service_feature_content_guard_href}	Update a feature content guard

add_role

NestedRoleResponse add_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.nested_role import NestedRole
from pulpcore.client.pulp_service.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
    service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | 
    nested_role = pulpcore.client.pulp_service.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsFeatureApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsFeatureApi->add_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_feature_content_guard_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

ServiceFeatureContentGuardResponse create(pulp_domain, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)

Create a feature content guard

Content guard to protect the content guarded by Subscription Features.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    service_feature_content_guard = pulpcore.client.pulp_service.ServiceFeatureContentGuard() # ServiceFeatureContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a feature content guard
        api_response = api_instance.create(pulp_domain, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsFeatureApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsFeatureApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
service_feature_content_guard	ServiceFeatureContentGuard
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

ServiceFeatureContentGuardResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

delete(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics)

Delete a feature content guard

Content guard to protect the content guarded by Subscription Features.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
    service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a feature content guard
        api_instance.delete(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ContentguardsFeatureApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_feature_content_guard_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

void (empty response body)

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedserviceFeatureContentGuardResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)

List feature content guards

Content guard to protect the content guarded by Subscription Features.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginatedservice_feature_content_guard_response_list import PaginatedserviceFeatureContentGuardResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | 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 = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List feature content guards
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsFeatureApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsFeatureApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Number of results to return per page.	[optional]
name	str	Filter results where name matches value	[optional]
name__contains	str	Filter results where name contains value	[optional]
name__icontains	str	Filter results where name contains value	[optional]
name__iexact	str	Filter results where name matches value	[optional]
name__in	List[str]	Filter results where name is in a comma-separated list of values	[optional]
name__iregex	str	Filter results where name matches regex value	[optional]
name__istartswith	str	Filter results where name starts with value	[optional]
name__regex	str	Filter results where name matches regex value	[optional]
name__startswith	str	Filter results where name starts with value	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	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	List[str]	Multiple values may be separated by commas.	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedserviceFeatureContentGuardResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_roles

ObjectRolesResponse list_roles(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
    service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsFeatureApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsFeatureApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_feature_content_guard_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ObjectRolesResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

my_permissions

MyPermissionsResponse my_permissions(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
    service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsFeatureApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsFeatureApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_feature_content_guard_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

MyPermissionsResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

ServiceFeatureContentGuardResponse partial_update(service_feature_content_guard_href, patchedservice_feature_content_guard, x_task_diagnostics=x_task_diagnostics)

Update a feature content guard

Content guard to protect the content guarded by Subscription Features.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.patchedservice_feature_content_guard import PatchedserviceFeatureContentGuard
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
    service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | 
    patchedservice_feature_content_guard = pulpcore.client.pulp_service.PatchedserviceFeatureContentGuard() # PatchedserviceFeatureContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a feature content guard
        api_response = api_instance.partial_update(service_feature_content_guard_href, patchedservice_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsFeatureApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsFeatureApi->partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_feature_content_guard_href	str
patchedservice_feature_content_guard	PatchedserviceFeatureContentGuard
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

ServiceFeatureContentGuardResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

ServiceFeatureContentGuardResponse read(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a feature content guard

Content guard to protect the content guarded by Subscription Features.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
    service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a feature content guard
        api_response = api_instance.read(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsFeatureApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsFeatureApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_feature_content_guard_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ServiceFeatureContentGuardResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_role

NestedRoleResponse remove_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.nested_role import NestedRole
from pulpcore.client.pulp_service.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
    service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | 
    nested_role = pulpcore.client.pulp_service.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsFeatureApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsFeatureApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_feature_content_guard_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

ServiceFeatureContentGuardResponse update(service_feature_content_guard_href, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)

Update a feature content guard

Content guard to protect the content guarded by Subscription Features.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
    service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | 
    service_feature_content_guard = pulpcore.client.pulp_service.ServiceFeatureContentGuard() # ServiceFeatureContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a feature content guard
        api_response = api_instance.update(service_feature_content_guard_href, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsFeatureApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsFeatureApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_feature_content_guard_href	str
service_feature_content_guard	ServiceFeatureContentGuard
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

ServiceFeatureContentGuardResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Domain

Serializer for Domain.

Properties

Name	Type	Description	Notes
name	str	A name for this domain.
description	str	An optional description.	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
storage_class	StorageClassEnum	Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage
storage_settings	object	Settings for storage class.
redirect_to_object_storage	bool	Boolean to have the content app redirect to object storage.	[optional] [default to True]
hide_guarded_distributions	bool	Boolean to hide distributions with a content guard in the content app.	[optional] [default to False]

Example

from pulpcore.client.pulp_service.models.domain import Domain

# TODO update the JSON string below
json = "{}"
# create an instance of Domain from a JSON string
domain_instance = Domain.from_json(json)
# print the JSON string representation of the object
print(Domain.to_json())

# convert the object into a dict
domain_dict = domain_instance.to_dict()
# create an instance of Domain from a dict
domain_from_dict = Domain.from_dict(domain_dict)

[Back to Model list] [Back to API list] [Back to README]

DomainResponse

Serializer for Domain.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
name	str	A name for this domain.
description	str	An optional description.	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
storage_class	StorageClassEnum	Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage
storage_settings	object	Settings for storage class.
redirect_to_object_storage	bool	Boolean to have the content app redirect to object storage.	[optional] [default to True]
hide_guarded_distributions	bool	Boolean to hide distributions with a content guard in the content app.	[optional] [default to False]

Example

from pulpcore.client.pulp_service.models.domain_response import DomainResponse

# TODO update the JSON string below
json = "{}"
# create an instance of DomainResponse from a JSON string
domain_response_instance = DomainResponse.from_json(json)
# print the JSON string representation of the object
print(DomainResponse.to_json())

# convert the object into a dict
domain_response_dict = domain_response_instance.to_dict()
# create an instance of DomainResponse from a dict
domain_response_from_dict = DomainResponse.from_dict(domain_response_dict)

[Back to Model list] [Back to API list] [Back to README]

MyPermissionsResponse

Properties

Name	Type	Description	Notes
permissions	List[str]

Example

from pulpcore.client.pulp_service.models.my_permissions_response import MyPermissionsResponse

# TODO update the JSON string below
json = "{}"
# create an instance of MyPermissionsResponse from a JSON string
my_permissions_response_instance = MyPermissionsResponse.from_json(json)
# print the JSON string representation of the object
print(MyPermissionsResponse.to_json())

# convert the object into a dict
my_permissions_response_dict = my_permissions_response_instance.to_dict()
# create an instance of MyPermissionsResponse from a dict
my_permissions_response_from_dict = MyPermissionsResponse.from_dict(my_permissions_response_dict)

[Back to Model list] [Back to API list] [Back to README]

NestedRole

Serializer to add/remove object roles to/from users/groups. This is used in conjunction with pulpcore.app.viewsets.base.RolesMixin and requires the underlying object to be passed as content_object in the context.

Properties

Name	Type	Notes
users	List[str]	[optional] [default to []]
groups	List[str]	[optional] [default to []]
role	str

Example

from pulpcore.client.pulp_service.models.nested_role import NestedRole

# TODO update the JSON string below
json = "{}"
# create an instance of NestedRole from a JSON string
nested_role_instance = NestedRole.from_json(json)
# print the JSON string representation of the object
print(NestedRole.to_json())

# convert the object into a dict
nested_role_dict = nested_role_instance.to_dict()
# create an instance of NestedRole from a dict
nested_role_from_dict = NestedRole.from_dict(nested_role_dict)

[Back to Model list] [Back to API list] [Back to README]

NestedRoleResponse

Properties

Name	Type	Notes
users	List[str]	[optional] [default to []]
groups	List[str]	[optional] [default to []]
role	str

Example

from pulpcore.client.pulp_service.models.nested_role_response import NestedRoleResponse

# TODO update the JSON string below
json = "{}"
# create an instance of NestedRoleResponse from a JSON string
nested_role_response_instance = NestedRoleResponse.from_json(json)
# print the JSON string representation of the object
print(NestedRoleResponse.to_json())

# convert the object into a dict
nested_role_response_dict = nested_role_response_instance.to_dict()
# create an instance of NestedRoleResponse from a dict
nested_role_response_from_dict = NestedRoleResponse.from_dict(nested_role_response_dict)

[Back to Model list] [Back to API list] [Back to README]

ObjectRolesResponse

Properties

Name	Type	Description	Notes
roles	List[NestedRoleResponse]

Example

from pulpcore.client.pulp_service.models.object_roles_response import ObjectRolesResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ObjectRolesResponse from a JSON string
object_roles_response_instance = ObjectRolesResponse.from_json(json)
# print the JSON string representation of the object
print(ObjectRolesResponse.to_json())

# convert the object into a dict
object_roles_response_dict = object_roles_response_instance.to_dict()
# create an instance of ObjectRolesResponse from a dict
object_roles_response_from_dict = ObjectRolesResponse.from_dict(object_roles_response_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedserviceFeatureContentGuardResponseList

Properties

Name	Type	Notes
count	int
next	str	[optional]
previous	str	[optional]
results	List[ServiceFeatureContentGuardResponse]

Example

from pulpcore.client.pulp_service.models.paginatedservice_feature_content_guard_response_list import PaginatedserviceFeatureContentGuardResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedserviceFeatureContentGuardResponseList from a JSON string
paginatedservice_feature_content_guard_response_list_instance = PaginatedserviceFeatureContentGuardResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedserviceFeatureContentGuardResponseList.to_json())

# convert the object into a dict
paginatedservice_feature_content_guard_response_list_dict = paginatedservice_feature_content_guard_response_list_instance.to_dict()
# create an instance of PaginatedserviceFeatureContentGuardResponseList from a dict
paginatedservice_feature_content_guard_response_list_from_dict = PaginatedserviceFeatureContentGuardResponseList.from_dict(paginatedservice_feature_content_guard_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedserviceVulnerabilityReportResponseList

Properties

Name	Type	Notes
count	int
next	str	[optional]
previous	str	[optional]
results	List[ServiceVulnerabilityReportResponse]

Example

from pulpcore.client.pulp_service.models.paginatedservice_vulnerability_report_response_list import PaginatedserviceVulnerabilityReportResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedserviceVulnerabilityReportResponseList from a JSON string
paginatedservice_vulnerability_report_response_list_instance = PaginatedserviceVulnerabilityReportResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedserviceVulnerabilityReportResponseList.to_json())

# convert the object into a dict
paginatedservice_vulnerability_report_response_list_dict = paginatedservice_vulnerability_report_response_list_instance.to_dict()
# create an instance of PaginatedserviceVulnerabilityReportResponseList from a dict
paginatedservice_vulnerability_report_response_list_from_dict = PaginatedserviceVulnerabilityReportResponseList.from_dict(paginatedservice_vulnerability_report_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedTaskResponseList

Properties

Name	Type	Notes
count	int
next	str	[optional]
previous	str	[optional]
results	List[TaskResponse]

Example

from pulpcore.client.pulp_service.models.paginated_task_response_list import PaginatedTaskResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedTaskResponseList from a JSON string
paginated_task_response_list_instance = PaginatedTaskResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedTaskResponseList.to_json())

# convert the object into a dict
paginated_task_response_list_dict = paginated_task_response_list_instance.to_dict()
# create an instance of PaginatedTaskResponseList from a dict
paginated_task_response_list_from_dict = PaginatedTaskResponseList.from_dict(paginated_task_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PatchedserviceFeatureContentGuard

A serializer for FeatureContentGuard.

Properties

Name	Type	Description	Notes
name	str	The unique name.	[optional]
description	str	An optional description.	[optional]
header_name	str		[optional]
jq_filter	str		[optional]
features	List[str]	The list of features required to access the content.	[optional]

Example

from pulpcore.client.pulp_service.models.patchedservice_feature_content_guard import PatchedserviceFeatureContentGuard

# TODO update the JSON string below
json = "{}"
# create an instance of PatchedserviceFeatureContentGuard from a JSON string
patchedservice_feature_content_guard_instance = PatchedserviceFeatureContentGuard.from_json(json)
# print the JSON string representation of the object
print(PatchedserviceFeatureContentGuard.to_json())

# convert the object into a dict
patchedservice_feature_content_guard_dict = patchedservice_feature_content_guard_instance.to_dict()
# create an instance of PatchedserviceFeatureContentGuard from a dict
patchedservice_feature_content_guard_from_dict = PatchedserviceFeatureContentGuard.from_dict(patchedservice_feature_content_guard_dict)

[Back to Model list] [Back to API list] [Back to README]

ProgressReportResponse

Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ref_name attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.

Properties

Name	Type	Description	Notes
message	str	The message shown to the user for the progress report.	[optional] [readonly]
code	str	Identifies the type of progress report'.	[optional] [readonly]
state	str	The current state of the progress report. The possible values are: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. The default is 'waiting'.	[optional] [readonly]
total	int	The total count of items.	[optional] [readonly]
done	int	The count of items already processed. Defaults to 0.	[optional] [readonly]
suffix	str	The suffix to be shown with the progress report.	[optional] [readonly]

Example

from pulpcore.client.pulp_service.models.progress_report_response import ProgressReportResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ProgressReportResponse from a JSON string
progress_report_response_instance = ProgressReportResponse.from_json(json)
# print the JSON string representation of the object
print(ProgressReportResponse.to_json())

# convert the object into a dict
progress_report_response_dict = progress_report_response_instance.to_dict()
# create an instance of ProgressReportResponse from a dict
progress_report_response_from_dict = ProgressReportResponse.from_dict(progress_report_response_dict)

[Back to Model list] [Back to API list] [Back to README]

ServiceFeatureContentGuard

A serializer for FeatureContentGuard.

Properties

Name	Type	Description	Notes
name	str	The unique name.
description	str	An optional description.	[optional]
header_name	str
jq_filter	str		[optional]
features	List[str]	The list of features required to access the content.

Example

from pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard

# TODO update the JSON string below
json = "{}"
# create an instance of ServiceFeatureContentGuard from a JSON string
service_feature_content_guard_instance = ServiceFeatureContentGuard.from_json(json)
# print the JSON string representation of the object
print(ServiceFeatureContentGuard.to_json())

# convert the object into a dict
service_feature_content_guard_dict = service_feature_content_guard_instance.to_dict()
# create an instance of ServiceFeatureContentGuard from a dict
service_feature_content_guard_from_dict = ServiceFeatureContentGuard.from_dict(service_feature_content_guard_dict)

[Back to Model list] [Back to API list] [Back to README]

ServiceFeatureContentGuardResponse

A serializer for FeatureContentGuard.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
name	str	The unique name.
description	str	An optional description.	[optional]
header_name	str
jq_filter	str		[optional]
features	List[str]	The list of features required to access the content.

Example

from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ServiceFeatureContentGuardResponse from a JSON string
service_feature_content_guard_response_instance = ServiceFeatureContentGuardResponse.from_json(json)
# print the JSON string representation of the object
print(ServiceFeatureContentGuardResponse.to_json())

# convert the object into a dict
service_feature_content_guard_response_dict = service_feature_content_guard_response_instance.to_dict()
# create an instance of ServiceFeatureContentGuardResponse from a dict
service_feature_content_guard_response_from_dict = ServiceFeatureContentGuardResponse.from_dict(service_feature_content_guard_response_dict)

[Back to Model list] [Back to API list] [Back to README]

ServiceVulnerabilityReportResponse

A serializer for the VulnerabilityReport Model.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
vulns	object

Example

from pulpcore.client.pulp_service.models.service_vulnerability_report_response import ServiceVulnerabilityReportResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ServiceVulnerabilityReportResponse from a JSON string
service_vulnerability_report_response_instance = ServiceVulnerabilityReportResponse.from_json(json)
# print the JSON string representation of the object
print(ServiceVulnerabilityReportResponse.to_json())

# convert the object into a dict
service_vulnerability_report_response_dict = service_vulnerability_report_response_instance.to_dict()
# create an instance of ServiceVulnerabilityReportResponse from a dict
service_vulnerability_report_response_from_dict = ServiceVulnerabilityReportResponse.from_dict(service_vulnerability_report_response_dict)

[Back to Model list] [Back to API list] [Back to README]

StorageClassEnum

pulpcore.app.models.storage.FileSystem - Use local filesystem as storage * storages.backends.s3boto3.S3Boto3Storage - Use Amazon S3 as storage * storages.backends.azure_storage.AzureStorage - Use Azure Blob as storage * pulp_service.app.storage.OCIStorage - Use OCI as storage

Enum

PULPCORE_DOT_APP_DOT_MODELS_DOT_STORAGE_DOT_FILE_SYSTEM (value: 'pulpcore.app.models.storage.FileSystem')
STORAGES_DOT_BACKENDS_DOT_S3BOTO3_DOT_S3_BOTO3_STORAGE (value: 'storages.backends.s3boto3.S3Boto3Storage')
STORAGES_DOT_BACKENDS_DOT_AZURE_STORAGE_DOT_AZURE_STORAGE (value: 'storages.backends.azure_storage.AzureStorage')
PULP_SERVICE_DOT_APP_DOT_STORAGE_DOT_OCI_STORAGE (value: 'pulp_service.app.storage.OCIStorage')

[Back to Model list] [Back to API list] [Back to README]

TaskResponse

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
state	str	The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'.	[optional] [readonly]
name	str	The name of task.
logging_cid	str	The logging correlation id associated with this task
created_by	str	User who dispatched this task.	[optional] [readonly]
unblocked_at	datetime	Timestamp of when this task was identified ready for pickup.	[optional] [readonly]
started_at	datetime	Timestamp of when this task started execution.	[optional] [readonly]
finished_at	datetime	Timestamp of when this task stopped execution.	[optional] [readonly]
error	object	A JSON Object of a fatal error encountered during the execution of this task.	[optional] [readonly]
worker	str	DEPRECATED - Always null	[optional] [readonly]
parent_task	str	The parent task that spawned this task.	[optional] [readonly]
child_tasks	List[str]	Any tasks spawned by this task.	[optional] [readonly]
task_group	str	The task group that this task is a member of.	[optional] [readonly]
progress_reports	List[ProgressReportResponse]		[optional] [readonly]
created_resources	List[str]	Resources created by this task.	[optional] [readonly]
reserved_resources_record	List[str]	A list of resources required by that task.	[optional] [readonly]
result	object	The result of this task.	[optional] [readonly]

Example

from pulpcore.client.pulp_service.models.task_response import TaskResponse

# TODO update the JSON string below
json = "{}"
# create an instance of TaskResponse from a JSON string
task_response_instance = TaskResponse.from_json(json)
# print the JSON string representation of the object
print(TaskResponse.to_json())

# convert the object into a dict
task_response_dict = task_response_instance.to_dict()
# create an instance of TaskResponse from a dict
task_response_from_dict = TaskResponse.from_dict(task_response_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_service.TasksApi

All URIs are relative to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
admin_tasks	GET /api/pulp/admin/tasks/

admin_tasks

PaginatedTaskResponseList admin_tasks(x_task_diagnostics=x_task_diagnostics, child_tasks=child_tasks, created_resources=created_resources, exclusive_resources=exclusive_resources, exclusive_resources__in=exclusive_resources__in, finished_at=finished_at, finished_at__gt=finished_at__gt, finished_at__gte=finished_at__gte, finished_at__isnull=finished_at__isnull, finished_at__lt=finished_at__lt, finished_at__lte=finished_at__lte, finished_at__range=finished_at__range, limit=limit, logging_cid=logging_cid, logging_cid__contains=logging_cid__contains, name=name, name__contains=name__contains, name__in=name__in, name__ne=name__ne, offset=offset, ordering=ordering, parent_task=parent_task, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, reserved_resources=reserved_resources, reserved_resources__in=reserved_resources__in, shared_resources=shared_resources, shared_resources__in=shared_resources__in, started_at=started_at, started_at__gt=started_at__gt, started_at__gte=started_at__gte, started_at__isnull=started_at__isnull, started_at__lt=started_at__lt, started_at__lte=started_at__lte, started_at__range=started_at__range, state=state, state__in=state__in, state__ne=state__ne, task_group=task_group, unblocked_at=unblocked_at, unblocked_at__gt=unblocked_at__gt, unblocked_at__gte=unblocked_at__gte, unblocked_at__isnull=unblocked_at__isnull, unblocked_at__lt=unblocked_at__lt, unblocked_at__lte=unblocked_at__lte, unblocked_at__range=unblocked_at__range, worker=worker, fields=fields, exclude_fields=exclude_fields)

A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the register_with method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginated_task_response_list import PaginatedTaskResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.TasksApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    child_tasks = 'child_tasks_example' # str | Filter results where child_tasks matches value (optional)
    created_resources = 'created_resources_example' # str |  (optional)
    exclusive_resources = 'exclusive_resources_example' # str |  (optional)
    exclusive_resources__in = ['exclusive_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    finished_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at matches value (optional)
    finished_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is greater than value (optional)
    finished_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is greater than or equal to value (optional)
    finished_at__isnull = True # bool | Filter results where finished_at has a null value (optional)
    finished_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is less than value (optional)
    finished_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is less than or equal to value (optional)
    finished_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where finished_at is between two comma separated values (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    logging_cid = 'logging_cid_example' # str | Filter results where logging_cid matches value (optional)
    logging_cid__contains = 'logging_cid__contains_example' # str | Filter results where logging_cid contains value (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__ne = 'name__ne_example' # str | Filter results where name not equal to value (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | 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) * `state` - State * `-state` - State (descending) * `name` - Name * `-name` - Name (descending) * `logging_cid` - Logging cid * `-logging_cid` - Logging cid (descending) * `unblocked_at` - Unblocked at * `-unblocked_at` - Unblocked at (descending) * `started_at` - Started at * `-started_at` - Started at (descending) * `finished_at` - Finished at * `-finished_at` - Finished at (descending) * `error` - Error * `-error` - Error (descending) * `enc_args` - Enc args * `-enc_args` - Enc args (descending) * `enc_kwargs` - Enc kwargs * `-enc_kwargs` - Enc kwargs (descending) * `reserved_resources_record` - Reserved resources record * `-reserved_resources_record` - Reserved resources record (descending) * `versions` - Versions * `-versions` - Versions (descending) * `profile_options` - Profile options * `-profile_options` - Profile options (descending) * `immediate` - Immediate * `-immediate` - Immediate (descending) * `deferred` - Deferred * `-deferred` - Deferred (descending) * `result` - Result * `-result` - Result (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    parent_task = 'parent_task_example' # str | Filter results where parent_task matches value (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)
    pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)
    pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)
    pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)
    pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)
    pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)
    pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    reserved_resources = 'reserved_resources_example' # str |  (optional)
    reserved_resources__in = ['reserved_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    shared_resources = 'shared_resources_example' # str |  (optional)
    shared_resources__in = ['shared_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    started_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at matches value (optional)
    started_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is greater than value (optional)
    started_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is greater than or equal to value (optional)
    started_at__isnull = True # bool | Filter results where started_at has a null value (optional)
    started_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is less than value (optional)
    started_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is less than or equal to value (optional)
    started_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where started_at is between two comma separated values (optional)
    state = 'state_example' # str | Filter results where state matches value  * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling (optional)
    state__in = ['state__in_example'] # List[str] | Filter results where state is in a comma-separated list of values (optional)
    state__ne = 'state__ne_example' # str | Filter results where state not equal to value (optional)
    task_group = 'task_group_example' # str | Filter results where task_group matches value (optional)
    unblocked_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at matches value (optional)
    unblocked_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is greater than value (optional)
    unblocked_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is greater than or equal to value (optional)
    unblocked_at__isnull = True # bool | Filter results where unblocked_at has a null value (optional)
    unblocked_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is less than value (optional)
    unblocked_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is less than or equal to value (optional)
    unblocked_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where unblocked_at is between two comma separated values (optional)
    worker = 'worker_example' # str |  (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        api_response = api_instance.admin_tasks(x_task_diagnostics=x_task_diagnostics, child_tasks=child_tasks, created_resources=created_resources, exclusive_resources=exclusive_resources, exclusive_resources__in=exclusive_resources__in, finished_at=finished_at, finished_at__gt=finished_at__gt, finished_at__gte=finished_at__gte, finished_at__isnull=finished_at__isnull, finished_at__lt=finished_at__lt, finished_at__lte=finished_at__lte, finished_at__range=finished_at__range, limit=limit, logging_cid=logging_cid, logging_cid__contains=logging_cid__contains, name=name, name__contains=name__contains, name__in=name__in, name__ne=name__ne, offset=offset, ordering=ordering, parent_task=parent_task, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, reserved_resources=reserved_resources, reserved_resources__in=reserved_resources__in, shared_resources=shared_resources, shared_resources__in=shared_resources__in, started_at=started_at, started_at__gt=started_at__gt, started_at__gte=started_at__gte, started_at__isnull=started_at__isnull, started_at__lt=started_at__lt, started_at__lte=started_at__lte, started_at__range=started_at__range, state=state, state__in=state__in, state__ne=state__ne, task_group=task_group, unblocked_at=unblocked_at, unblocked_at__gt=unblocked_at__gt, unblocked_at__gte=unblocked_at__gte, unblocked_at__isnull=unblocked_at__isnull, unblocked_at__lt=unblocked_at__lt, unblocked_at__lte=unblocked_at__lte, unblocked_at__range=unblocked_at__range, worker=worker, fields=fields, exclude_fields=exclude_fields)
        print("The response of TasksApi->admin_tasks:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TasksApi->admin_tasks: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
child_tasks	str	Filter results where child_tasks matches value	[optional]
created_resources	str		[optional]
exclusive_resources	str		[optional]
exclusive_resources__in	List[str]	Multiple values may be separated by commas.	[optional]
finished_at	datetime	Filter results where finished_at matches value	[optional]
finished_at__gt	datetime	Filter results where finished_at is greater than value	[optional]
finished_at__gte	datetime	Filter results where finished_at is greater than or equal to value	[optional]
finished_at__isnull	bool	Filter results where finished_at has a null value	[optional]
finished_at__lt	datetime	Filter results where finished_at is less than value	[optional]
finished_at__lte	datetime	Filter results where finished_at is less than or equal to value	[optional]
finished_at__range	List[datetime]	Filter results where finished_at is between two comma separated values	[optional]
limit	int	Number of results to return per page.	[optional]
logging_cid	str	Filter results where logging_cid matches value	[optional]
logging_cid__contains	str	Filter results where logging_cid contains value	[optional]
name	str	Filter results where name matches value	[optional]
name__contains	str	Filter results where name contains value	[optional]
name__in	List[str]	Filter results where name is in a comma-separated list of values	[optional]
name__ne	str	Filter results where name not equal to value	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	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) * `state` - State * `-state` - State (descending) * `name` - Name * `-name` - Name (descending) * `logging_cid` - Logging cid * `-logging_cid` - Logging cid (descending) * `unblocked_at` - Unblocked at * `-unblocked_at` - Unblocked at (descending) * `started_at` - Started at * `-started_at` - Started at (descending) * `finished_at` - Finished at * `-finished_at` - Finished at (descending) * `error` - Error * `-error` - Error (descending) * `enc_args` - Enc args * `-enc_args` - Enc args (descending) * `enc_kwargs` - Enc kwargs * `-enc_kwargs` - Enc kwargs (descending) * `reserved_resources_record` - Reserved resources record * `-reserved_resources_record` - Reserved resources record (descending) * `versions` - Versions * `-versions` - Versions (descending) * `profile_options` - Profile options * `-profile_options` - Profile options (descending) * `immediate` - Immediate * `-immediate` - Immediate (descending) * `deferred` - Deferred * `-deferred` - Deferred (descending) * `result` - Result * `-result` - Result (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
parent_task	str	Filter results where parent_task matches value	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_created	datetime	Filter results where pulp_created matches value	[optional]
pulp_created__gt	datetime	Filter results where pulp_created is greater than value	[optional]
pulp_created__gte	datetime	Filter results where pulp_created is greater than or equal to value	[optional]
pulp_created__isnull	bool	Filter results where pulp_created has a null value	[optional]
pulp_created__lt	datetime	Filter results where pulp_created is less than value	[optional]
pulp_created__lte	datetime	Filter results where pulp_created is less than or equal to value	[optional]
pulp_created__range	List[datetime]	Filter results where pulp_created is between two comma separated values	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
reserved_resources	str		[optional]
reserved_resources__in	List[str]	Multiple values may be separated by commas.	[optional]
shared_resources	str		[optional]
shared_resources__in	List[str]	Multiple values may be separated by commas.	[optional]
started_at	datetime	Filter results where started_at matches value	[optional]
started_at__gt	datetime	Filter results where started_at is greater than value	[optional]
started_at__gte	datetime	Filter results where started_at is greater than or equal to value	[optional]
started_at__isnull	bool	Filter results where started_at has a null value	[optional]
started_at__lt	datetime	Filter results where started_at is less than value	[optional]
started_at__lte	datetime	Filter results where started_at is less than or equal to value	[optional]
started_at__range	List[datetime]	Filter results where started_at is between two comma separated values	[optional]
state	str	Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling	[optional]
state__in	List[str]	Filter results where state is in a comma-separated list of values	[optional]
state__ne	str	Filter results where state not equal to value	[optional]
task_group	str	Filter results where task_group matches value	[optional]
unblocked_at	datetime	Filter results where unblocked_at matches value	[optional]
unblocked_at__gt	datetime	Filter results where unblocked_at is greater than value	[optional]
unblocked_at__gte	datetime	Filter results where unblocked_at is greater than or equal to value	[optional]
unblocked_at__isnull	bool	Filter results where unblocked_at has a null value	[optional]
unblocked_at__lt	datetime	Filter results where unblocked_at is less than value	[optional]
unblocked_at__lte	datetime	Filter results where unblocked_at is less than or equal to value	[optional]
unblocked_at__range	List[datetime]	Filter results where unblocked_at is between two comma separated values	[optional]
worker	str		[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedTaskResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_service.VulnReportServiceApi

All URIs are relative to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
create	POST /api/pulp/{pulp_domain}/api/v3/vuln_report_service/	Generate vulnerability report
delete	DELETE {service_vulnerability_report_href}	Delete a vulnerability report
list	GET /api/pulp/{pulp_domain}/api/v3/vuln_report_service/	List vulnerability reports
read	GET {service_vulnerability_report_href}	Inspect a vulnerability report

create

AsyncOperationResponse create(pulp_domain, x_task_diagnostics=x_task_diagnostics, repo_version=repo_version, package_json=package_json)

Generate vulnerability report

Trigger a task to generate the package vulnerability report

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    repo_version = 'repo_version_example' # str | RepositoryVersion HREF with the packages to be checked. (optional)
    package_json = None # bytearray | package-lock.json file with the definition of dependencies to be checked. (optional)

    try:
        # Generate vulnerability report
        api_response = api_instance.create(pulp_domain, x_task_diagnostics=x_task_diagnostics, repo_version=repo_version, package_json=package_json)
        print("The response of VulnReportServiceApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnReportServiceApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
repo_version	str	RepositoryVersion HREF with the packages to be checked.	[optional]
package_json	bytearray	package-lock.json file with the definition of dependencies to be checked.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

delete(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics)

Delete a vulnerability report

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)
    service_vulnerability_report_href = 'service_vulnerability_report_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a vulnerability report
        api_instance.delete(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling VulnReportServiceApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_vulnerability_report_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

void (empty response body)

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedserviceVulnerabilityReportResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)

List vulnerability reports

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginatedservice_vulnerability_report_response_list import PaginatedserviceVulnerabilityReportResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List vulnerability reports
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
        print("The response of VulnReportServiceApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnReportServiceApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedserviceVulnerabilityReportResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

ServiceVulnerabilityReportResponse read(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a vulnerability report

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_vulnerability_report_response import ServiceVulnerabilityReportResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
    host = "https://env-ephemeral-43b86r.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_service.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)
    service_vulnerability_report_href = 'service_vulnerability_report_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a vulnerability report
        api_response = api_instance.read(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of VulnReportServiceApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnReportServiceApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_vulnerability_report_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ServiceVulnerabilityReportResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Project details

These details have not been verified by PyPI

Release history Release notifications | RSS feed

20260417.2

Apr 17, 2026

20260417.1

Apr 17, 2026

20260416.5

Apr 16, 2026

20260416.4

Apr 16, 2026

20260416.3

Apr 16, 2026

20260416.2

Apr 16, 2026

20260416.1

Apr 16, 2026

20260415.4

Apr 15, 2026

20260415.3

Apr 15, 2026

20260415.2

Apr 15, 2026

20260415.1

Apr 15, 2026

20260414.3

Apr 14, 2026

20260414.2

Apr 14, 2026

20260414.1

Apr 14, 2026

20260410.1

Apr 10, 2026

20260408.1

Apr 8, 2026

20260402.2

Apr 2, 2026

20260402.1

Apr 2, 2026

20260331.3

Mar 31, 2026

20260331.2

Mar 31, 2026

20260331.1

Mar 31, 2026

20260330.3

Mar 30, 2026

20260330.2

Mar 30, 2026

20260330.1

Mar 30, 2026

20260326.1

Mar 26, 2026

20260325.1

Mar 25, 2026

20260324.2

Mar 24, 2026

20260324.1

Mar 24, 2026

20260323.1

Mar 23, 2026

20260319.2

Mar 19, 2026

20260319.1

Mar 19, 2026

20260318.6

Mar 18, 2026

20260318.5

Mar 18, 2026

20260318.4

Mar 18, 2026

20260318.3

Mar 18, 2026

20260318.2

Mar 18, 2026

20260318.1

Mar 18, 2026

20260317.2

Mar 17, 2026

20260317.1

Mar 17, 2026

20260316.1

Mar 16, 2026

20260315.1

Mar 15, 2026

20260312.1

Mar 12, 2026

20260311.1

Mar 11, 2026

20260310.1

Mar 10, 2026

20260309.1

Mar 9, 2026

20260306.3

Mar 6, 2026

20260306.2

Mar 6, 2026

20260306.1

Mar 6, 2026

20260305.1

Mar 5, 2026

20260304.1

Mar 4, 2026

20260303.1

Mar 3, 2026

20260302.5

Mar 2, 2026

20260302.4

Mar 2, 2026

20260302.3

Mar 2, 2026

20260302.2

Mar 2, 2026

20260302.1

Mar 2, 2026

20260227.1

Feb 27, 2026

20260226.1

Feb 26, 2026

20260224.2

Feb 24, 2026

20260224.1

Feb 24, 2026

20260223.1

Feb 23, 2026

20260219.2

Feb 19, 2026

20260219.1

Feb 19, 2026

20260218.1

Feb 18, 2026

20260216.3

Feb 16, 2026

20260216.2

Feb 16, 2026

20260216.1

Feb 16, 2026

20260212.2

Feb 12, 2026

20260212.1

Feb 12, 2026

20260211.1

Feb 11, 2026

20260209.3

Feb 9, 2026

20260209.2

Feb 9, 2026

20260209.1

Feb 9, 2026

20260206.1

Feb 6, 2026

20260205.2

Feb 5, 2026

20260205.1

Feb 5, 2026

20260204.2

Feb 4, 2026

20260204.1

Feb 4, 2026

20260203.1

Feb 3, 2026

20260202.3

Feb 2, 2026

20260202.2

Feb 2, 2026

20260202.1

Feb 2, 2026

20260130.1

Jan 30, 2026

20260129.1

Jan 29, 2026

20260128.1

Jan 28, 2026

20260123.3

Jan 23, 2026

20260123.2

Jan 23, 2026

20260123.1

Jan 23, 2026

20260122.1

Jan 22, 2026

20260121.8

Jan 21, 2026

20260121.7

Jan 21, 2026

20260121.6

Jan 21, 2026

20260121.5

Jan 21, 2026

20260121.4

Jan 21, 2026

20260121.3

Jan 21, 2026

20260121.2

Jan 21, 2026

20260121.1

Jan 21, 2026

20260120.5

Jan 20, 2026

20260120.4

Jan 20, 2026

20260120.3

Jan 20, 2026

20260120.2

Jan 20, 2026

20260120.1

Jan 20, 2026

20260119.3

Jan 19, 2026

20260119.2

Jan 19, 2026

20260119.1

Jan 19, 2026

20260116.5

Jan 16, 2026

20260116.4

Jan 16, 2026

20260116.3

Jan 16, 2026

20260116.2

Jan 16, 2026

20260116.1

Jan 16, 2026

20260115.6

Jan 15, 2026

20260115.5

Jan 15, 2026

20260115.4

Jan 15, 2026

20260115.3

Jan 15, 2026

20260115.2

Jan 15, 2026

20260115.1

Jan 15, 2026

20260114.7

Jan 14, 2026

20260114.6

Jan 14, 2026

20260114.5

Jan 14, 2026

20260114.4

Jan 14, 2026

20260114.3

Jan 14, 2026

20260114.2

Jan 14, 2026

20260114.1

Jan 14, 2026

20260113.7

Jan 13, 2026

20260113.6

Jan 13, 2026

20260113.5

Jan 13, 2026

20260113.4

Jan 13, 2026

20260113.3

Jan 13, 2026

20260113.2

Jan 13, 2026

20260113.1

Jan 13, 2026

20260112.2

Jan 12, 2026

20260112.1

Jan 12, 2026

20260109.2

Jan 9, 2026

This version

20260109.1

Jan 9, 2026

20260108.3

Jan 8, 2026

20260108.2

Jan 8, 2026

20260108.1

Jan 8, 2026

20260107.3

Jan 7, 2026

20260107.2

Jan 7, 2026

20260107.1

Jan 7, 2026

20260106.3

Jan 6, 2026

20260106.2

Jan 6, 2026

20260106.1

Jan 6, 2026

20260105.2

Jan 5, 2026

20260105.1

Jan 5, 2026

20251229.2

Dec 29, 2025

20251229.1

Dec 29, 2025

20251222.1

Dec 22, 2025

20251220.1

Dec 20, 2025

20251219.1

Dec 19, 2025

20251218.2

Dec 18, 2025

20251218.1

Dec 18, 2025

20251217.1

Dec 17, 2025

20251216.1

Dec 16, 2025

20251215.1

Dec 15, 2025

20251212.1

Dec 12, 2025

20251211.2

Dec 11, 2025

20251211.1

Dec 11, 2025

20251210.4

Dec 10, 2025

20251210.3

Dec 10, 2025

20251210.2

Dec 10, 2025

20251210.1

Dec 10, 2025

20251209.2

Dec 9, 2025

20251209.1

Dec 9, 2025

20251208.2

Dec 8, 2025

20251208.1

Dec 8, 2025

20251207.1

Dec 7, 2025

20251204.4

Dec 4, 2025

20251204.3

Dec 4, 2025

20251204.2

Dec 4, 2025

20251204.1

Dec 4, 2025

20251203.3

Dec 3, 2025

20251203.2

Dec 3, 2025

20251203.1

Dec 3, 2025

20251202.2

Dec 2, 2025

20251202.1

Dec 2, 2025

20251126.2

Nov 26, 2025

20251126.1

Nov 26, 2025

20251121.1

Nov 21, 2025

20251119.1

Nov 19, 2025

20251118.2

Nov 18, 2025

20251118.1

Nov 18, 2025

20251117.2

Nov 17, 2025

20251117.1

Nov 17, 2025

20251113.2

Nov 13, 2025

20251113.1

Nov 13, 2025

20251112.4

Nov 12, 2025

20251112.3

Nov 12, 2025

20251112.2

Nov 12, 2025

20251112.1

Nov 12, 2025

20251111.2

Nov 11, 2025

20251111.1

Nov 11, 2025

20251107.2

Nov 7, 2025

20251107.1

Nov 7, 2025

20251105.1

Nov 5, 2025

20251104.3

Nov 4, 2025

20251104.2

Nov 4, 2025

20251104.1

Nov 4, 2025

20251030.1

Oct 30, 2025

20251028.1

Oct 28, 2025

20251027.1

Oct 27, 2025

20251025.1

Oct 25, 2025

20251023.4

Oct 23, 2025

20251023.3

Oct 23, 2025

20251023.2

Oct 23, 2025

20251023.1

Oct 23, 2025

20251021.4

Oct 21, 2025

20251021.3

Oct 21, 2025

20251021.2

Oct 21, 2025

20251021.1

Oct 21, 2025

20251017.2

Oct 17, 2025

20251017.1

Oct 17, 2025

20251016.3

Oct 16, 2025

20251016.2

Oct 16, 2025

20251016.1

Oct 16, 2025

20251014.3

Oct 14, 2025

20251014.2

Oct 14, 2025

20251014.1

Oct 14, 2025

20251010.1

Oct 10, 2025

20251009.2

Oct 9, 2025

20251009.1

Oct 9, 2025

20251008.2

Oct 8, 2025

20251008.1

Oct 8, 2025

20251007.2

Oct 7, 2025

20251007.1

Oct 7, 2025

20251006.1

Oct 6, 2025

20251002.1

Oct 2, 2025

20251001.4

Oct 1, 2025

20251001.3

Oct 1, 2025

20251001.2

Oct 1, 2025

20251001.1

Oct 1, 2025

20250930.2

Sep 30, 2025

20250930.1

Sep 30, 2025

20250929.1

Sep 29, 2025

20250925.2

Sep 25, 2025

20250925.1

Sep 25, 2025

20250923.5

Sep 23, 2025

20250923.4

Sep 23, 2025

20250923.3

Sep 23, 2025

20250923.2

Sep 23, 2025

20250923.1

Sep 23, 2025

20250922.4

Sep 22, 2025

20250922.3

Sep 22, 2025

20250922.2

Sep 22, 2025

20250922.1

Sep 22, 2025

20250919.1

Sep 19, 2025

20250918.1

Sep 18, 2025

20250917.2

Sep 17, 2025

20250917.1

Sep 17, 2025

20250916.2

Sep 16, 2025

20250916.1

Sep 16, 2025

20250915.3

Sep 15, 2025

20250915.2

Sep 15, 2025

20250915.1

Sep 15, 2025

20250911.1

Sep 11, 2025

20250909.1

Sep 9, 2025

20250908.1

Sep 8, 2025

20250905.2

Sep 5, 2025

20250905.1

Sep 5, 2025

20250903.4

Sep 3, 2025

20250903.3

Sep 3, 2025

20250903.2

Sep 3, 2025

20250903.1

Sep 3, 2025

20250902.1

Sep 2, 2025

20250901.1

Sep 1, 2025

20250829.2

Aug 29, 2025

20250829.1

Aug 29, 2025

20250828.3

Aug 28, 2025

20250828.2

Aug 28, 2025

20250828.1

Aug 28, 2025

20250826.2

Aug 26, 2025

20250826.1

Aug 26, 2025

20250825.1

Aug 25, 2025

20250821.4

Aug 21, 2025

20250821.3

Aug 21, 2025

20250821.2

Aug 21, 2025

20250821.1

Aug 21, 2025

20250820.1

Aug 20, 2025

20250819.1

Aug 20, 2025

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crc_pulp_service_client-20260109.1.tar.gz (68.4 kB view details)

Uploaded Jan 9, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

crc_pulp_service_client-20260109.1-py3-none-any.whl (90.7 kB view details)

Uploaded Jan 9, 2026 Python 3

File details

Details for the file crc_pulp_service_client-20260109.1.tar.gz.

File metadata

Download URL: crc_pulp_service_client-20260109.1.tar.gz
Upload date: Jan 9, 2026
Size: 68.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for crc_pulp_service_client-20260109.1.tar.gz
Algorithm	Hash digest
SHA256	`624895b71fd034f2fc64db3bf0e92fdc2a23b8a47527496cb06d39c4eacbc764`
MD5	`ab4f4336b4a4818501cdac74e91fa9ba`
BLAKE2b-256	`0edb2e70b38ea50002614c0579c53010a7a1ff9269d6c439f1af3a2c098c7597`

See more details on using hashes here.

File details

Details for the file crc_pulp_service_client-20260109.1-py3-none-any.whl.

File metadata

Download URL: crc_pulp_service_client-20260109.1-py3-none-any.whl
Upload date: Jan 9, 2026
Size: 90.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for crc_pulp_service_client-20260109.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`98e2728b59608e9da884dce10859554c3d04029461bdf9afc7fe088900444e52`
MD5	`2c2142214c117df3de91c92399e48926`
BLAKE2b-256	`14d5fbacd80c64e9bb0220b3fb4ebc111171f246435e07d1cf36bc5c2471b31f`

See more details on using hashes here.

crc-pulp-service-client 20260109.1

Navigation

Verified details

Maintainers

Unverified details

Meta

Project description

pulpcore.client.pulp_service.ApiCreateDomainApi

post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pulpcore.client.pulp_service.ApiDebugAuthHeaderApi

get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pulpcore.client.pulp_service.ApiDebugDatabaseTriggersApi

get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pulpcore.client.pulp_service.ApiRdsConnectionTestsApi

get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pulpcore.client.pulp_service.ApiTestRandomLockTasksApi

get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pulpcore.client.pulp_service.ApiTestTasksApi

get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

AsyncOperationResponse

Properties

Example

pulpcore.client.pulp_service.ContentguardsFeatureApi

add_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details