crc-pulp-service-client 20260917.1

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

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		-

pulpcore.client.pulp_service.ApiDebugAuthHeaderApi

All URIs are relative to https://env-ephemeral-re6q6o.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 and client IP information.

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-re6q6o.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-re6q6o.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.ApiDebugCleanupStaleLocksApi

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

Method	HTTP request	Description
get	GET /api/pulp/debug/cleanup-stale-locks/
post	POST /api/pulp/debug/cleanup-stale-locks/	Dispatch stale lock cleanup

get

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

Return endpoint documentation.

Example

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-re6q6o.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-re6q6o.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.

# 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.ApiDebugCleanupStaleLocksApi(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 ApiDebugCleanupStaleLocksApi->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

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

post

AsyncOperationResponse post(x_task_diagnostics=x_task_diagnostics)

Dispatch stale lock cleanup

Dispatch a background task that scans Redis for orphaned locks and removes them.

Example

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-re6q6o.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-re6q6o.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.

# 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.ApiDebugCleanupStaleLocksApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Dispatch stale lock cleanup
        api_response = api_instance.post(x_task_diagnostics=x_task_diagnostics)
        print("The response of ApiDebugCleanupStaleLocksApi->post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiDebugCleanupStaleLocksApi->post: %s\n" % e)

Parameters

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

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

pulpcore.client.pulp_service.ApiDebugDatabaseTriggersApi

All URIs are relative to https://env-ephemeral-re6q6o.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-re6q6o.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-re6q6o.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.ApiDebugReleaseTaskLocksApi

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

Method	HTTP request	Description
get	GET /api/pulp/debug/release-task-locks/

get

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

Release all Redis locks for a given task UUID. Query parameters: task_id: UUID of the task to release locks for Returns: 200: Locks released successfully 400: Missing or invalid task_id parameter 404: Task not found 500: Error releasing locks

Example

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-re6q6o.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-re6q6o.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.

# 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.ApiDebugReleaseTaskLocksApi(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 ApiDebugReleaseTaskLocksApi->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

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

pulpcore.client.pulp_service.ApiDebugStaleLocksApi

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

Method	HTTP request	Description
get	GET /api/pulp/debug/stale-locks/

get

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

Admin-only endpoint that scans Redis for orphaned/stale locks. Performs a system-wide scan of all Redis resource lock keys (pulp:resource_lock:) and task lock keys (task:), checks whether each lock holder is still an online AppStatus process, and flags orphaned locks from dead workers. This is the primary tool for proactive detection of Bug 2: Redis locks that persist forever because a worker died without cleaning up. Unlike task-debug (which examines a single task) or task-queue (which examines waiting/running tasks), this endpoint discovers ALL locks in Redis regardless of task state -- including locks left behind by tasks that have already completed, failed, or been canceled. Query parameters: include_healthy (bool): If "true", include locks held by online processes in the response. Default: false (only show stale/orphaned). page_size (int): Maximum number of lock keys to return per page. Default: 100. Max: 500. cursor (int): Redis SCAN cursor to resume from. Default: 0 (start). scan_type (str): Which lock types to scan -- "resource", "task", or "all" (default). Response structure: summary: Counts of total, orphaned, and healthy locks orphaned_resource_locks: Resource locks held by dead processes orphaned_task_locks: Task locks held by dead processes healthy_resource_locks: (optional) Locks held by online processes healthy_task_locks: (optional) Task locks held by online processes lock_holder_liveness: Liveness status of all unique lock holders task_correlations: Mapping of orphaned resources to related tasks worker_summary: Current online worker/API process counts next_cursor: Redis SCAN cursor to pass on the next request (0 = done) has_more: Whether more results are available page_size: The page_size that was used scan_type: The scan_type that was used

Example

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-re6q6o.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-re6q6o.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.

# 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.ApiDebugStaleLocksApi(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 ApiDebugStaleLocksApi->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

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

pulpcore.client.pulp_service.ApiDebugTaskDebugApi

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

Method	HTTP request	Description
get	GET /api/pulp/debug/task-debug/

get

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

Admin-only endpoint providing comprehensive debug information for a task. Returns task state, app_lock info, Redis lock state for all resources, queue position, blocking tasks, version compatibility analysis, FIFO blocking simulation, lock holder liveness, and an automated diagnosis explaining WHY the task is stuck. Covers detection of all 5 known stuck-task bugs: Bug 1: app_lock set but never cleared after is_compatible() failure Bug 2: Orphaned Redis locks from dead workers (no TTL) Bug 3: FETCH_TASK_LIMIT=20 starvation Bug 4: FIFO resource blocking in worker fetch loop Bug 5: Split Redis between API and worker clusters

Example

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-re6q6o.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-re6q6o.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.

# 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.ApiDebugTaskDebugApi(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 ApiDebugTaskDebugApi->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

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

pulpcore.client.pulp_service.ApiDebugTaskQueueApi

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

Method	HTTP request	Description
get	GET /api/pulp/debug/task-queue/

get

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

Admin-only endpoint listing the oldest waiting and running tasks. Returns task info with Redis lock state for each, giving operators the same view workers have when calling fetch_task(). Includes per-task diagnosis, lock holder liveness, and queue-wide health indicators.

Example

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-re6q6o.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-re6q6o.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.

# 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.ApiDebugTaskQueueApi(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 ApiDebugTaskQueueApi->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

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

pulpcore.client.pulp_service.ApiMigrateDomainApi

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

Method	HTTP request	Description
create	POST /api/pulp/migrate-domain/	Migrate domain storage to S3

create

AsyncOperationResponse create(create_request, x_task_diagnostics=x_task_diagnostics)

Migrate domain storage to S3

Trigger a storage backend migration for the specified domain. Storage settings are sourced from the template-domain-s3 domain — callers do not need to provide any storage credentials.

Example

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.models.create_request import CreateRequest
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ApiMigrateDomainApi(api_client)
    create_request = pulpcore.client.pulp_service.CreateRequest() # CreateRequest | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Migrate domain storage to S3
        api_response = api_instance.create(create_request, x_task_diagnostics=x_task_diagnostics)
        print("The response of ApiMigrateDomainApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiMigrateDomainApi->create: %s\n" % e)

Parameters

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

Return type

Authorization

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

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

pulpcore.client.pulp_service.ApiRdsConnectionTestsApi

All URIs are relative to https://env-ephemeral-re6q6o.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-re6q6o.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-re6q6o.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-re6q6o.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-re6q6o.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

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

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

pulpcore.client.pulp_service.ApiTestPagerdutyAlertApi

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

Method	HTTP request	Description
post	POST /api/pulp/test/pagerduty-alert/

post

post(x_task_diagnostics=x_task_diagnostics)

Arm the synthetic pagerduty.test gauge for one hour. Requires staff authentication. Used to fire PulpPagerDutyTest in prod (pages PagerDuty) or stage (Alertmanager blackhole; Prometheus only).

Example

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-re6q6o.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-re6q6o.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.

# 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.ApiTestPagerdutyAlertApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        api_instance.post(x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ApiTestPagerdutyAlertApi->post: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

pulpcore.client.pulp_service.ApiTestRandomLockTasksApi

All URIs are relative to https://env-ephemeral-re6q6o.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-re6q6o.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-re6q6o.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-re6q6o.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-re6q6o.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-re6q6o.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]

pulpcore.client.pulp_service.ApiTestTriggerOomApi

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

Method	HTTP request	Description
post	POST /api/pulp/test/trigger-oom/

post

post(x_task_diagnostics=x_task_diagnostics)

Allocates memory until the container is OOMKilled. Requires superuser authentication. Only available on stage (ENV_NAME=stage).

Example

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-re6q6o.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-re6q6o.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.

# 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.ApiTestTriggerOomApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        api_instance.post(x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ApiTestTriggerOomApi->post: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

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-re6q6o.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

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-re6q6o.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-re6q6o.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.

# 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

Authorization

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

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		-

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

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-re6q6o.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-re6q6o.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.

# 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

Authorization

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

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		-

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

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-re6q6o.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-re6q6o.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.

# 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

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

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

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-re6q6o.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-re6q6o.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.

# 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

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

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-re6q6o.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-re6q6o.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.

# 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

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

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-re6q6o.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-re6q6o.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.

# 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

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

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-re6q6o.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-re6q6o.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.

# 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

Authorization

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

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		-

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

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-re6q6o.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-re6q6o.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.

# 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

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

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-re6q6o.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-re6q6o.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.

# 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

Authorization

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

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		-

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

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-re6q6o.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-re6q6o.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.

# 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

Authorization

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

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		-

ContentViewErrataResponse

A representation of an UpdateRecord (advisory/errata) for Content View search results.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
id	str	Update id (e.g. RHEA-2013:1777)
updated_date	str	Date when the update was updated
issued_date	str	Date when the update was issued
description	str	Update description
title	str	Update name
summary	str	Short summary
version	str	Update version
type	str	Update type ('enhancement', 'bugfix', ...)
severity	str	Severity
solution	str	Solution
release	str	Update release
rights	str	Copyrights
reboot_suggested	bool	Whether a reboot is suggested
cves	str	CVE references attached to this errata	[optional] [readonly]

Example

from pulpcore.client.pulp_service.models.content_view_errata_response import ContentViewErrataResponse

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

# convert the object into a dict
content_view_errata_response_dict = content_view_errata_response_instance.to_dict()
# create an instance of ContentViewErrataResponse from a dict
content_view_errata_response_from_dict = ContentViewErrataResponse.from_dict(content_view_errata_response_dict)

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

ContentViewModuleStreamResponse

A representation of a Modulemd for Content View search results.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
name	str	Name of the modulemd
stream	str	The modulemd's stream
version	str	The version of the modulemd
context	str	The modulemd's context flag
arch	str	Module artifact architecture
description	str	A verbose description of the module
profiles	object	Package lists of installable profiles
packages	str	Names of packages in this module	[optional] [readonly]

Example

from pulpcore.client.pulp_service.models.content_view_module_stream_response import ContentViewModuleStreamResponse

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

# convert the object into a dict
content_view_module_stream_response_dict = content_view_module_stream_response_instance.to_dict()
# create an instance of ContentViewModuleStreamResponse from a dict
content_view_module_stream_response_from_dict = ContentViewModuleStreamResponse.from_dict(content_view_module_stream_response_dict)

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

ContentViewPackageEnvironmentResponse

A representation of a PackageEnvironment for Content View search results.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
id	str	ID of the environment
name	str	The name of the environment
description	str	The description of the environment
group_ids	object	A list of group ids

Example

from pulpcore.client.pulp_service.models.content_view_package_environment_response import ContentViewPackageEnvironmentResponse

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

# convert the object into a dict
content_view_package_environment_response_dict = content_view_package_environment_response_instance.to_dict()
# create an instance of ContentViewPackageEnvironmentResponse from a dict
content_view_package_environment_response_from_dict = ContentViewPackageEnvironmentResponse.from_dict(content_view_package_environment_response_dict)

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

ContentViewPackageGroupResponse

A representation of a PackageGroup for Content View search results.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
id	str	ID of the group
name	str	Name of the group
description	str	Description of the group
packages	object	The list of packages in this group

Example

from pulpcore.client.pulp_service.models.content_view_package_group_response import ContentViewPackageGroupResponse

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

# convert the object into a dict
content_view_package_group_response_dict = content_view_package_group_response_instance.to_dict()
# create an instance of ContentViewPackageGroupResponse from a dict
content_view_package_group_response_from_dict = ContentViewPackageGroupResponse.from_dict(content_view_package_group_response_dict)

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

ContentViewPackageResponse

A lightweight representation of a Package for Content View search results. Used by the packages/ (typeahead) and packages/list/ search endpoints. Instances may originate from any domain the ContentView's Distributions span, so pulp_href resolves per-object using each Package's own domain.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
name	str	Name of the package
epoch	str	The package's epoch
version	str	The version of the package
release	str	The release of the package
arch	str	The target architecture for the package
summary	str	Short description of the packaged software
description	str	In-depth description of the package
checksum_type	str	Type of checksum, e.g. 'sha256'
pkg_id	str	Checksum of the package file
url	str	URL with more information about the package
location_href	str	Relative location of the package
is_modular	bool	Whether the package is modular

Example

from pulpcore.client.pulp_service.models.content_view_package_response import ContentViewPackageResponse

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

# convert the object into a dict
content_view_package_response_dict = content_view_package_response_instance.to_dict()
# create an instance of ContentViewPackageResponse from a dict
content_view_package_response_from_dict = ContentViewPackageResponse.from_dict(content_view_package_response_dict)

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

pulpcore.client.pulp_service.ContentViewsApi

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

Method	HTTP request	Description
add_role	POST {service_content_view_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/content-views/	Create a content view
delete	DELETE {service_content_view_href}	Delete a content view
list	GET /api/pulp/{pulp_domain}/api/v3/content-views/	List content views
list_roles	GET {service_content_view_href}list_roles/	List roles
my_permissions	GET {service_content_view_href}my_permissions/	List user permissions
partial_update	PATCH {service_content_view_href}	Update a content view
read	GET {service_content_view_href}	Inspect a content view
remove_role	POST {service_content_view_href}remove_role/	Remove a role
set_label	POST {service_content_view_href}set_label/	Set a label
unset_label	POST {service_content_view_href}unset_label/	Unset a label
update	PUT {service_content_view_href}	Update a content view

add_role

NestedRoleResponse add_role(service_content_view_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

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-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(api_client)
    service_content_view_href = 'service_content_view_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_content_view_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentViewsApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsApi->add_role: %s\n" % e)

Parameters

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

Return type

Authorization

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

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		-

create

ServiceContentViewResponse create(pulp_domain, service_content_view, x_task_diagnostics=x_task_diagnostics)

Create a content view

ViewSet for ContentView. A ContentView is a named, persistable scope composed of Distributions -- potentially spanning multiple domains -- that can be searched across (see the nested content-views/{content_view_pk}/search/rpm/... endpoints below for the actual search operations; this viewset only provides the standard CRUD lifecycle for the resource itself).

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_content_view import ServiceContentView
from pulpcore.client.pulp_service.models.service_content_view_response import ServiceContentViewResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    service_content_view = pulpcore.client.pulp_service.ServiceContentView() # ServiceContentView | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

Authorization

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

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		-

delete

delete(service_content_view_href, x_task_diagnostics=x_task_diagnostics)

Delete a content view

Example

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-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(api_client)
    service_content_view_href = 'service_content_view_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

list

PaginatedserviceContentViewResponseList 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, pulp_label_select=pulp_label_select, q=q, fields=fields, exclude_fields=exclude_fields)

List content views

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginatedservice_content_view_response_list import PaginatedserviceContentViewResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(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) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (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)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (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 content views
        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, pulp_label_select=pulp_label_select, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentViewsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsApi->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) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (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]
pulp_label_select	str	Filter labels by search string	[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

PaginatedserviceContentViewResponseList

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

list_roles

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

List roles

List roles assigned to this object.

Example

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-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(api_client)
    service_content_view_href = 'service_content_view_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_content_view_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentViewsApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_content_view_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

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

my_permissions

MyPermissionsResponse my_permissions(service_content_view_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

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-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(api_client)
    service_content_view_href = 'service_content_view_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_content_view_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentViewsApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_content_view_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

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

partial_update

ServiceContentViewResponse partial_update(service_content_view_href, patchedservice_content_view, x_task_diagnostics=x_task_diagnostics)

Update a content view

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.patchedservice_content_view import PatchedserviceContentView
from pulpcore.client.pulp_service.models.service_content_view_response import ServiceContentViewResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(api_client)
    service_content_view_href = 'service_content_view_href_example' # str | 
    patchedservice_content_view = pulpcore.client.pulp_service.PatchedserviceContentView() # PatchedserviceContentView | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a content view
        api_response = api_instance.partial_update(service_content_view_href, patchedservice_content_view, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentViewsApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsApi->partial_update: %s\n" % e)

Parameters

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

Return type

Authorization

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

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		-

read

ServiceContentViewResponse read(service_content_view_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a content view

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_content_view_response import ServiceContentViewResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(api_client)
    service_content_view_href = 'service_content_view_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 content view
        api_response = api_instance.read(service_content_view_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentViewsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_content_view_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

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

remove_role

NestedRoleResponse remove_role(service_content_view_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

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-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(api_client)
    service_content_view_href = 'service_content_view_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_content_view_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentViewsApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsApi->remove_role: %s\n" % e)

Parameters

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

Return type

Authorization

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

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		-

set_label

SetLabelResponse set_label(service_content_view_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.set_label import SetLabel
from pulpcore.client.pulp_service.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(api_client)
    service_content_view_href = 'service_content_view_href_example' # str | 
    set_label = pulpcore.client.pulp_service.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(service_content_view_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentViewsApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsApi->set_label: %s\n" % e)

Parameters

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

Return type

SetLabelResponse

Authorization

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

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		-

unset_label

UnsetLabelResponse unset_label(service_content_view_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.unset_label import UnsetLabel
from pulpcore.client.pulp_service.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(api_client)
    service_content_view_href = 'service_content_view_href_example' # str | 
    unset_label = pulpcore.client.pulp_service.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(service_content_view_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentViewsApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsApi->unset_label: %s\n" % e)

Parameters

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

Return type

UnsetLabelResponse

Authorization

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

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		-

update

ServiceContentViewResponse update(service_content_view_href, service_content_view, x_task_diagnostics=x_task_diagnostics)

Update a content view

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_content_view import ServiceContentView
from pulpcore.client.pulp_service.models.service_content_view_response import ServiceContentViewResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsApi(api_client)
    service_content_view_href = 'service_content_view_href_example' # str | 
    service_content_view = pulpcore.client.pulp_service.ServiceContentView() # ServiceContentView | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a content view
        api_response = api_instance.update(service_content_view_href, service_content_view, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentViewsApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsApi->update: %s\n" % e)

Parameters

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

Return type

Authorization

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

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		-

pulpcore.client.pulp_service.ContentViewsRpmEnvironmentsApi

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

Method	HTTP request	Description
list	GET {service_content_view_href}search/rpm/environments/	List content view search scopes

list

PaginatedContentViewPackageEnvironmentResponseList list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, search=search, fields=fields, exclude_fields=exclude_fields)

List content view search scopes

Typeahead package-environment search: substring match, deduplicated by (name, id).

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginated_content_view_package_environment_response_list import PaginatedContentViewPackageEnvironmentResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsRpmEnvironmentsApi(api_client)
    service_content_view_href = 'service_content_view_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Maximum number of results to return. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    search = 'search_example' # str | Case-insensitive substring/prefix search term. (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 content view search scopes
        api_response = api_instance.list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, search=search, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentViewsRpmEnvironmentsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsRpmEnvironmentsApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_content_view_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Maximum number of results to return.	[optional]
offset	int	The initial index from which to return the results.	[optional]
search	str	Case-insensitive substring/prefix search term.	[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

PaginatedContentViewPackageEnvironmentResponseList

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

pulpcore.client.pulp_service.ContentViewsRpmErrataApi

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

Method	HTTP request	Description
list	GET {service_content_view_href}search/rpm/errata/	List content view search scopes

list

PaginatedContentViewErrataResponseList list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, search=search, severity=severity, sort_by=sort_by, type=type, fields=fields, exclude_fields=exclude_fields)

List content view search scopes

Full errata (advisory) search: filter/sort/paginate, with CVE references included.

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginated_content_view_errata_response_list import PaginatedContentViewErrataResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsRpmErrataApi(api_client)
    service_content_view_href = 'service_content_view_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Maximum number of results to return. (optional)
    offset = 56 # int | Number of results to skip. (optional)
    search = 'search_example' # str | Case-insensitive substring/prefix search term. (optional)
    severity = 'severity_example' # str | Comma-separated list of errata severities to include (known values: ['critical', 'important', 'low', 'moderate', 'none']; anything else matches as an 'other' catch-all bucket). (optional)
    sort_by = 'sort_by_example' # str | Field to sort by; prefix with '-' for descending order. (optional)
    type = 'type_example' # str | Comma-separated list of errata types to include (known values: ['bugfix', 'enhancement', 'newpackage', 'security']; anything else matches as an 'other' catch-all bucket). (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 content view search scopes
        api_response = api_instance.list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, search=search, severity=severity, sort_by=sort_by, type=type, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentViewsRpmErrataApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsRpmErrataApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_content_view_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Maximum number of results to return.	[optional]
offset	int	Number of results to skip.	[optional]
search	str	Case-insensitive substring/prefix search term.	[optional]
severity	str	Comma-separated list of errata severities to include (known values: ['critical', 'important', 'low', 'moderate', 'none']; anything else matches as an 'other' catch-all bucket).	[optional]
sort_by	str	Field to sort by; prefix with '-' for descending order.	[optional]
type	str	Comma-separated list of errata types to include (known values: ['bugfix', 'enhancement', 'newpackage', 'security']; anything else matches as an 'other' catch-all bucket).	[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

PaginatedContentViewErrataResponseList

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

pulpcore.client.pulp_service.ContentViewsRpmModuleStreamsApi

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

Method	HTTP request	Description
list	GET {service_content_view_href}search/rpm/module-streams/	List content view search scopes

list

PaginatedContentViewModuleStreamResponseList list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, rpm_names=rpm_names, search=search, sort_by=sort_by, fields=fields, exclude_fields=exclude_fields)

List content view search scopes

Module stream search: name/stream substring match, optional RPM name filter, capped.

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginated_content_view_module_stream_response_list import PaginatedContentViewModuleStreamResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsRpmModuleStreamsApi(api_client)
    service_content_view_href = 'service_content_view_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Maximum number of results to return. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    rpm_names = 'rpm_names_example' # str | Comma-separated list of RPM package names; only module streams containing at least one of these packages are returned. (optional)
    search = 'search_example' # str | Case-insensitive substring/prefix search term. (optional)
    sort_by = 'sort_by_example' # str | Field to sort by; prefix with '-' for descending order. (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 content view search scopes
        api_response = api_instance.list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, rpm_names=rpm_names, search=search, sort_by=sort_by, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentViewsRpmModuleStreamsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsRpmModuleStreamsApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_content_view_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Maximum number of results to return.	[optional]
offset	int	The initial index from which to return the results.	[optional]
rpm_names	str	Comma-separated list of RPM package names; only module streams containing at least one of these packages are returned.	[optional]
search	str	Case-insensitive substring/prefix search term.	[optional]
sort_by	str	Field to sort by; prefix with '-' for descending order.	[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

PaginatedContentViewModuleStreamResponseList

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

pulpcore.client.pulp_service.ContentViewsRpmPackageGroupsApi

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

Method	HTTP request	Description
list	GET {service_content_view_href}search/rpm/package-groups/	List content view search scopes

list

PaginatedContentViewPackageGroupResponseList list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, search=search, fields=fields, exclude_fields=exclude_fields)

List content view search scopes

Typeahead package-group search: substring match, with the packages list of same-keyed groups found in multiple domains/repository versions unioned together.

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginated_content_view_package_group_response_list import PaginatedContentViewPackageGroupResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsRpmPackageGroupsApi(api_client)
    service_content_view_href = 'service_content_view_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Maximum number of results to return. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    search = 'search_example' # str | Case-insensitive substring/prefix search term. (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 content view search scopes
        api_response = api_instance.list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, search=search, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentViewsRpmPackageGroupsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsRpmPackageGroupsApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_content_view_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Maximum number of results to return.	[optional]
offset	int	The initial index from which to return the results.	[optional]
search	str	Case-insensitive substring/prefix search term.	[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

PaginatedContentViewPackageGroupResponseList

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

pulpcore.client.pulp_service.ContentViewsRpmPackagesApi

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

Method	HTTP request	Description
list	GET {service_content_view_href}search/rpm/packages/	List content view search scopes

list

PaginatedContentViewPackageResponseList list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, search=search, fields=fields, exclude_fields=exclude_fields)

List content view search scopes

Typeahead package search: prefix match, deduplicated by name.

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginated_content_view_package_response_list import PaginatedContentViewPackageResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsRpmPackagesApi(api_client)
    service_content_view_href = 'service_content_view_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Maximum number of results to return. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    search = 'search_example' # str | Case-insensitive substring/prefix search term. (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 content view search scopes
        api_response = api_instance.list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, search=search, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentViewsRpmPackagesApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsRpmPackagesApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_content_view_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Maximum number of results to return.	[optional]
offset	int	The initial index from which to return the results.	[optional]
search	str	Case-insensitive substring/prefix search term.	[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

PaginatedContentViewPackageResponseList

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

pulpcore.client.pulp_service.ContentViewsRpmPackagesListApi

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

Method	HTTP request	Description
list	GET {service_content_view_href}search/rpm/packages/list/	List content view search scopes

list

PaginatedContentViewPackageResponseList list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, offset=offset, fields=fields, exclude_fields=exclude_fields)

List content view search scopes

Full package listing: exact name filter, fixed NEVRA sort, paginated.

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginated_content_view_package_response_list import PaginatedContentViewPackageResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.ContentViewsRpmPackagesListApi(api_client)
    service_content_view_href = 'service_content_view_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Maximum number of results to return. (optional)
    name = 'name_example' # str | Exact package name to filter by. (optional)
    offset = 56 # int | Number of results to skip. (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 content view search scopes
        api_response = api_instance.list(service_content_view_href, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, offset=offset, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentViewsRpmPackagesListApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentViewsRpmPackagesListApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_content_view_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Maximum number of results to return.	[optional]
name	str	Exact package name to filter by.	[optional]
offset	int	Number of results to skip.	[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

PaginatedContentViewPackageResponseList

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

CreateRequest

Properties

Name	Type	Description	Notes
name	str	Name of the domain to migrate.

Example

from pulpcore.client.pulp_service.models.create_request import CreateRequest

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

# convert the object into a dict
create_request_dict = create_request_instance.to_dict()
# create an instance of CreateRequest from a dict
create_request_from_dict = CreateRequest.from_dict(create_request_dict)

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

pulpcore.client.pulp_service.Datarepair7465V2Api

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

Method	HTTP request	Description
post	POST /api/pulp/{pulp_domain}/api/v3/datarepair/7465-v2/	Rebuild content_ids cache (Issue #7465)

post

AsyncOperationResponse post(pulp_domain, x_task_diagnostics=x_task_diagnostics)

Rebuild content_ids cache (Issue #7465)

Trigger an async task that populates missing content_ids cache on repository versions.

Example

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-re6q6o.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-re6q6o.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.

# 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.Datarepair7465V2Api(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)

    try:
        # Rebuild content_ids cache (Issue #7465)
        api_response = api_instance.post(pulp_domain, x_task_diagnostics=x_task_diagnostics)
        print("The response of Datarepair7465V2Api->post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling Datarepair7465V2Api->post: %s\n" % e)

Parameters

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

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

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 [deprecated] * `storages.backends.s3.S3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob 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]
default_content_guard	str	An optional content-guard that is automatically assigned to new distributions created within this domain when they do not specify their own content-guard. To apply multiple guards by default, use a composite content-guard.	[optional]

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 [deprecated] * `storages.backends.s3.S3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob 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]
default_content_guard	str	An optional content-guard that is automatically assigned to new distributions created within this domain when they do not specify their own content-guard. To apply multiple guards by default, use a composite content-guard.	[optional]
default_content_guard_prn	str	The Pulp Resource Name (PRN) of the domain's default content-guard.	[optional] [readonly]

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]

PaginatedContentViewErrataResponseList

Properties

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

Example

from pulpcore.client.pulp_service.models.paginated_content_view_errata_response_list import PaginatedContentViewErrataResponseList

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

# convert the object into a dict
paginated_content_view_errata_response_list_dict = paginated_content_view_errata_response_list_instance.to_dict()
# create an instance of PaginatedContentViewErrataResponseList from a dict
paginated_content_view_errata_response_list_from_dict = PaginatedContentViewErrataResponseList.from_dict(paginated_content_view_errata_response_list_dict)

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

PaginatedContentViewModuleStreamResponseList

Properties

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

Example

from pulpcore.client.pulp_service.models.paginated_content_view_module_stream_response_list import PaginatedContentViewModuleStreamResponseList

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

# convert the object into a dict
paginated_content_view_module_stream_response_list_dict = paginated_content_view_module_stream_response_list_instance.to_dict()
# create an instance of PaginatedContentViewModuleStreamResponseList from a dict
paginated_content_view_module_stream_response_list_from_dict = PaginatedContentViewModuleStreamResponseList.from_dict(paginated_content_view_module_stream_response_list_dict)

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

PaginatedContentViewPackageEnvironmentResponseList

Properties

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

Example

from pulpcore.client.pulp_service.models.paginated_content_view_package_environment_response_list import PaginatedContentViewPackageEnvironmentResponseList

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

# convert the object into a dict
paginated_content_view_package_environment_response_list_dict = paginated_content_view_package_environment_response_list_instance.to_dict()
# create an instance of PaginatedContentViewPackageEnvironmentResponseList from a dict
paginated_content_view_package_environment_response_list_from_dict = PaginatedContentViewPackageEnvironmentResponseList.from_dict(paginated_content_view_package_environment_response_list_dict)

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

PaginatedContentViewPackageGroupResponseList

Properties

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

Example

from pulpcore.client.pulp_service.models.paginated_content_view_package_group_response_list import PaginatedContentViewPackageGroupResponseList

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

# convert the object into a dict
paginated_content_view_package_group_response_list_dict = paginated_content_view_package_group_response_list_instance.to_dict()
# create an instance of PaginatedContentViewPackageGroupResponseList from a dict
paginated_content_view_package_group_response_list_from_dict = PaginatedContentViewPackageGroupResponseList.from_dict(paginated_content_view_package_group_response_list_dict)

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

PaginatedContentViewPackageResponseList

Properties

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

Example

from pulpcore.client.pulp_service.models.paginated_content_view_package_response_list import PaginatedContentViewPackageResponseList

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

# convert the object into a dict
paginated_content_view_package_response_list_dict = paginated_content_view_package_response_list_instance.to_dict()
# create an instance of PaginatedContentViewPackageResponseList from a dict
paginated_content_view_package_response_list_from_dict = PaginatedContentViewPackageResponseList.from_dict(paginated_content_view_package_response_list_dict)

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

PaginatedserviceContentViewResponseList

Properties

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

Example

from pulpcore.client.pulp_service.models.paginatedservice_content_view_response_list import PaginatedserviceContentViewResponseList

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

# convert the object into a dict
paginatedservice_content_view_response_list_dict = paginatedservice_content_view_response_list_instance.to_dict()
# create an instance of PaginatedserviceContentViewResponseList from a dict
paginatedservice_content_view_response_list_from_dict = PaginatedserviceContentViewResponseList.from_dict(paginatedservice_content_view_response_list_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]

PaginatedservicePyPIYankMonitorResponseList

Properties

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

Example

from pulpcore.client.pulp_service.models.paginatedservice_py_pi_yank_monitor_response_list import PaginatedservicePyPIYankMonitorResponseList

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

# convert the object into a dict
paginatedservice_py_pi_yank_monitor_response_list_dict = paginatedservice_py_pi_yank_monitor_response_list_instance.to_dict()
# create an instance of PaginatedservicePyPIYankMonitorResponseList from a dict
paginatedservice_py_pi_yank_monitor_response_list_from_dict = PaginatedservicePyPIYankMonitorResponseList.from_dict(paginatedservice_py_pi_yank_monitor_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]

PatchedserviceContentView

Serializer for a ContentView -- a named, persistable scope composed of Distributions that may span multiple domains, used to search across their content without exposing raw repository version hrefs on every request.

Properties

Name	Type	Description	Notes
name	str	A unique name for this content view.	[optional]
description	str	An optional description of this content view.	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
distributions	List[str]	Distributions this content view searches across. May reference distributions belonging to any domain the user has read access to, not just this content view's own domain.	[optional]

Example

from pulpcore.client.pulp_service.models.patchedservice_content_view import PatchedserviceContentView

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

# convert the object into a dict
patchedservice_content_view_dict = patchedservice_content_view_instance.to_dict()
# create an instance of PatchedserviceContentView from a dict
patchedservice_content_view_from_dict = PatchedserviceContentView.from_dict(patchedservice_content_view_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_hreffield. The class provides a default for theref_nameattribute in the ModelSerializers'sMeta` 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]

pulpcore.client.pulp_service.PypiYankMonitorApi

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

Method	HTTP request	Description
add_role	POST {service_py_p_i_yank_monitor_href}add_role/	Add a role
check	POST {service_py_p_i_yank_monitor_href}check/
create	POST /api/pulp/{pulp_domain}/api/v3/pypi_yank_monitor/	Create a py pi yank monitor
delete	DELETE {service_py_p_i_yank_monitor_href}	Delete a py pi yank monitor
list	GET /api/pulp/{pulp_domain}/api/v3/pypi_yank_monitor/	List py pi yank monitors
list_roles	GET {service_py_p_i_yank_monitor_href}list_roles/	List roles
my_permissions	GET {service_py_p_i_yank_monitor_href}my_permissions/	List user permissions
read	GET {service_py_p_i_yank_monitor_href}	Inspect a py pi yank monitor
remove_role	POST {service_py_p_i_yank_monitor_href}remove_role/	Remove a role
report	GET {service_py_p_i_yank_monitor_href}report/

add_role

NestedRoleResponse add_role(service_py_p_i_yank_monitor_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

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-re6q6o.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-re6q6o.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.

# 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.PypiYankMonitorApi(api_client)
    service_py_p_i_yank_monitor_href = 'service_py_p_i_yank_monitor_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_py_p_i_yank_monitor_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of PypiYankMonitorApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PypiYankMonitorApi->add_role: %s\n" % e)

Parameters

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

Return type

Authorization

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

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		-

check

AsyncOperationResponse check(service_py_p_i_yank_monitor_href, x_task_diagnostics=x_task_diagnostics)

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

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-re6q6o.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-re6q6o.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.

# 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.PypiYankMonitorApi(api_client)
    service_py_p_i_yank_monitor_href = 'service_py_p_i_yank_monitor_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        api_response = api_instance.check(service_py_p_i_yank_monitor_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of PypiYankMonitorApi->check:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PypiYankMonitorApi->check: %s\n" % e)

Parameters

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

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

create

ServicePyPIYankMonitorResponse create(pulp_domain, service_py_pi_yank_monitor, x_task_diagnostics=x_task_diagnostics)

Create a py pi yank monitor

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_py_pi_yank_monitor import ServicePyPIYankMonitor
from pulpcore.client.pulp_service.models.service_py_pi_yank_monitor_response import ServicePyPIYankMonitorResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.PypiYankMonitorApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    service_py_pi_yank_monitor = pulpcore.client.pulp_service.ServicePyPIYankMonitor() # ServicePyPIYankMonitor | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a py pi yank monitor
        api_response = api_instance.create(pulp_domain, service_py_pi_yank_monitor, x_task_diagnostics=x_task_diagnostics)
        print("The response of PypiYankMonitorApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PypiYankMonitorApi->create: %s\n" % e)

Parameters

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

Return type

ServicePyPIYankMonitorResponse

Authorization

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

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		-

delete

delete(service_py_p_i_yank_monitor_href, x_task_diagnostics=x_task_diagnostics)

Delete a py pi yank monitor

Example

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-re6q6o.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-re6q6o.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.

# 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.PypiYankMonitorApi(api_client)
    service_py_p_i_yank_monitor_href = 'service_py_p_i_yank_monitor_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a py pi yank monitor
        api_instance.delete(service_py_p_i_yank_monitor_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling PypiYankMonitorApi->delete: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

list

PaginatedservicePyPIYankMonitorResponseList 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, pulp_label_select=pulp_label_select, q=q, repository=repository, fields=fields, exclude_fields=exclude_fields)

List py pi yank monitors

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginatedservice_py_pi_yank_monitor_response_list import PaginatedservicePyPIYankMonitorResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.PypiYankMonitorApi(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) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `last_checked` - Last checked * `-last_checked` - Last checked (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)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository = 'repository_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:
        # List py pi yank monitors
        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, pulp_label_select=pulp_label_select, q=q, repository=repository, fields=fields, exclude_fields=exclude_fields)
        print("The response of PypiYankMonitorApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PypiYankMonitorApi->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) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `last_checked` - Last checked * `-last_checked` - Last checked (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]
pulp_label_select	str	Filter labels by search string	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
repository	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

PaginatedservicePyPIYankMonitorResponseList

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

list_roles

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

List roles

List roles assigned to this object.

Example

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-re6q6o.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-re6q6o.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.

# 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.PypiYankMonitorApi(api_client)
    service_py_p_i_yank_monitor_href = 'service_py_p_i_yank_monitor_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_py_p_i_yank_monitor_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PypiYankMonitorApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PypiYankMonitorApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_py_p_i_yank_monitor_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

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

my_permissions

MyPermissionsResponse my_permissions(service_py_p_i_yank_monitor_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

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-re6q6o.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-re6q6o.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.

# 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.PypiYankMonitorApi(api_client)
    service_py_p_i_yank_monitor_href = 'service_py_p_i_yank_monitor_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_py_p_i_yank_monitor_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PypiYankMonitorApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PypiYankMonitorApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_py_p_i_yank_monitor_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

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

read

ServicePyPIYankMonitorResponse read(service_py_p_i_yank_monitor_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a py pi yank monitor

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_py_pi_yank_monitor_response import ServicePyPIYankMonitorResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.PypiYankMonitorApi(api_client)
    service_py_p_i_yank_monitor_href = 'service_py_p_i_yank_monitor_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 py pi yank monitor
        api_response = api_instance.read(service_py_p_i_yank_monitor_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PypiYankMonitorApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PypiYankMonitorApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_py_p_i_yank_monitor_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

ServicePyPIYankMonitorResponse

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

remove_role

NestedRoleResponse remove_role(service_py_p_i_yank_monitor_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

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-re6q6o.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-re6q6o.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.

# 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.PypiYankMonitorApi(api_client)
    service_py_p_i_yank_monitor_href = 'service_py_p_i_yank_monitor_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_py_p_i_yank_monitor_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of PypiYankMonitorApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PypiYankMonitorApi->remove_role: %s\n" % e)

Parameters

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

Return type

Authorization

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

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		-

report

ServiceYankedPackageReportResponse report(service_py_p_i_yank_monitor_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Example

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

import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_yanked_package_report_response import ServiceYankedPackageReportResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-re6q6o.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-re6q6o.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.

# 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.PypiYankMonitorApi(api_client)
    service_py_p_i_yank_monitor_href = 'service_py_p_i_yank_monitor_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:
        api_response = api_instance.report(service_py_p_i_yank_monitor_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PypiYankMonitorApi->report:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PypiYankMonitorApi->report: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_py_p_i_yank_monitor_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

ServiceYankedPackageReportResponse

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ServiceContentView

Properties

Name	Type	Description	Notes
name	str	A unique name for this content view.
description	str	An optional description of this content view.	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
distributions	List[str]	Distributions this content view searches across. May reference distributions belonging to any domain the user has read access to, not just this content view's own domain.	[optional]

Example

from pulpcore.client.pulp_service.models.service_content_view import ServiceContentView

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

# convert the object into a dict
service_content_view_dict = service_content_view_instance.to_dict()
# create an instance of ServiceContentView from a dict
service_content_view_from_dict = ServiceContentView.from_dict(service_content_view_dict)

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

ServiceContentViewResponse

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 unique name for this content view.
description	str	An optional description of this content view.	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
distributions	List[str]	Distributions this content view searches across. May reference distributions belonging to any domain the user has read access to, not just this content view's own domain.	[optional]
distributions_status	str	Per-distribution resolution status: whether each linked distribution's domain is currently accessible and whether it resolves to a repository version.	[optional] [readonly]

Example

from pulpcore.client.pulp_service.models.service_content_view_response import ServiceContentViewResponse

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

# convert the object into a dict
service_content_view_response_dict = service_content_view_response_instance.to_dict()
# create an instance of ServiceContentViewResponse from a dict
service_content_view_response_from_dict = ServiceContentViewResponse.from_dict(service_content_view_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]

ServicePyPIYankMonitor

A serializer for the PyPIYankMonitor Model.

Properties

Name	Type	Notes
name	str
description	str	[optional]
pulp_labels	Dict[str, Optional[str]]	[optional]
repository	str	[optional]
repository_version	str	[optional]
last_checked	datetime	[optional]

Example

from pulpcore.client.pulp_service.models.service_py_pi_yank_monitor import ServicePyPIYankMonitor

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

# convert the object into a dict
service_py_pi_yank_monitor_dict = service_py_pi_yank_monitor_instance.to_dict()
# create an instance of ServicePyPIYankMonitor from a dict
service_py_pi_yank_monitor_from_dict = ServicePyPIYankMonitor.from_dict(service_py_pi_yank_monitor_dict)

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

ServicePyPIYankMonitorResponse

A serializer for the PyPIYankMonitor 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]
name	str
description	str		[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
repository	str		[optional]
repository_version	str		[optional]
last_checked	datetime		[optional]

Example

from pulpcore.client.pulp_service.models.service_py_pi_yank_monitor_response import ServicePyPIYankMonitorResponse

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

# convert the object into a dict
service_py_pi_yank_monitor_response_dict = service_py_pi_yank_monitor_response_instance.to_dict()
# create an instance of ServicePyPIYankMonitorResponse from a dict
service_py_pi_yank_monitor_response_from_dict = ServicePyPIYankMonitorResponse.from_dict(service_py_pi_yank_monitor_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]

ServiceYankedPackageReportResponse

A serializer for the YankedPackageReport Model.

Properties

Name	Type	Description	Notes
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]
report	object
repository_name	str		[optional]

Example

from pulpcore.client.pulp_service.models.service_yanked_package_report_response import ServiceYankedPackageReportResponse

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

# convert the object into a dict
service_yanked_package_report_response_dict = service_yanked_package_report_response_instance.to_dict()
# create an instance of ServiceYankedPackageReportResponse from a dict
service_yanked_package_report_response_from_dict = ServiceYankedPackageReportResponse.from_dict(service_yanked_package_report_response_dict)

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

SetLabel

Serializer for synchronously setting a label.

Properties

Name	Type	Description	Notes
key	str
value	str

Example

from pulpcore.client.pulp_service.models.set_label import SetLabel

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

# convert the object into a dict
set_label_dict = set_label_instance.to_dict()
# create an instance of SetLabel from a dict
set_label_from_dict = SetLabel.from_dict(set_label_dict)

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

SetLabelResponse

Serializer for synchronously setting a label.

Properties

Name	Type	Description	Notes
key	str
value	str

Example

from pulpcore.client.pulp_service.models.set_label_response import SetLabelResponse

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

# convert the object into a dict
set_label_response_dict = set_label_response_instance.to_dict()
# create an instance of SetLabelResponse from a dict
set_label_response_from_dict = SetLabelResponse.from_dict(set_label_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 [deprecated] * storages.backends.s3.S3Storage - Use Amazon S3 as storage * storages.backends.azure_storage.AzureStorage - Use Azure Blob 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_S3_DOT_S3_STORAGE (value: 'storages.backends.s3.S3Storage')
STORAGES_DOT_BACKENDS_DOT_AZURE_STORAGE_DOT_AZURE_STORAGE (value: 'storages.backends.azure_storage.AzureStorage')

[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]
created_resource_prns	List[str]	Resources created by this task as PRNs.	[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]
pulp_api_version	str	The API-version that was invoked when creating the task.	[optional] [default to 'v3']

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-re6q6o.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)

Example

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-re6q6o.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-re6q6o.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.

# 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 |  (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) * `pulp_api_version` - Pulp api version * `-pulp_api_version` - Pulp api version (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    parent_task = 'parent_task_example' # str |  (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 |  (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		[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) * `pulp_api_version` - Pulp api version * `-pulp_api_version` - Pulp api version (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
parent_task	str		[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		[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

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

UnsetLabel

Serializer for synchronously UNsetting a label.

Properties

Name	Type	Description	Notes
key	str

Example

from pulpcore.client.pulp_service.models.unset_label import UnsetLabel

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

# convert the object into a dict
unset_label_dict = unset_label_instance.to_dict()
# create an instance of UnsetLabel from a dict
unset_label_from_dict = UnsetLabel.from_dict(unset_label_dict)

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

UnsetLabelResponse

Serializer for synchronously UNsetting a label.

Properties

Name	Type	Description	Notes
key	str
value	str		[optional] [readonly]

Example

from pulpcore.client.pulp_service.models.unset_label_response import UnsetLabelResponse

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

# convert the object into a dict
unset_label_response_dict = unset_label_response_instance.to_dict()
# create an instance of UnsetLabelResponse from a dict
unset_label_response_from_dict = UnsetLabelResponse.from_dict(unset_label_response_dict)

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

pulpcore.client.pulp_service.VulnReportServiceApi

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

Method	HTTP request	Description
add_role	POST {service_vulnerability_report_href}add_role/	Add a role
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
list_roles	GET {service_vulnerability_report_href}list_roles/	List roles
my_permissions	GET {service_vulnerability_report_href}my_permissions/	List user permissions
read	GET {service_vulnerability_report_href}	Inspect a vulnerability report
remove_role	POST {service_vulnerability_report_href}remove_role/	Remove a role

add_role

NestedRoleResponse add_role(service_vulnerability_report_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

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-re6q6o.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-re6q6o.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.

# 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 | 
    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_vulnerability_report_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of VulnReportServiceApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnReportServiceApi->add_role: %s\n" % e)

Parameters

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

Return type

Authorization

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

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		-

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

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-re6q6o.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-re6q6o.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.

# 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

Authorization

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

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		-

delete

delete(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics)

Delete a vulnerability report

Example

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-re6q6o.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-re6q6o.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.

# 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

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

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

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-re6q6o.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-re6q6o.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.

# 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

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

list_roles

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

List roles

List roles assigned to this object.

Example

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-re6q6o.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-re6q6o.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.

# 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:
        # List roles
        api_response = api_instance.list_roles(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of VulnReportServiceApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnReportServiceApi->list_roles: %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

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

my_permissions

MyPermissionsResponse my_permissions(service_vulnerability_report_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

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-re6q6o.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-re6q6o.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.

# 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:
        # List user permissions
        api_response = api_instance.my_permissions(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of VulnReportServiceApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnReportServiceApi->my_permissions: %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

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

read

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

Inspect a vulnerability report

Example

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-re6q6o.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-re6q6o.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.

# 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

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

remove_role

NestedRoleResponse remove_role(service_vulnerability_report_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

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-re6q6o.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-re6q6o.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.

# 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 | 
    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_vulnerability_report_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of VulnReportServiceApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnReportServiceApi->remove_role: %s\n" % e)

Parameters

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

Return type

Authorization