endpoints

async idem_vra.exec.vra.pipeline.endpoints.create_endpoint_using_post(hub, ctx, name, properties, type, **kwargs)

Create an Endpoint Create an Endpoint based on the given project Performs POST /codestream/api/endpoints

Parameters:

• name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

• properties (object) – (required in body) Endpoint specific properties

• type (string) – (required in body) The type of this Endpoint instance.

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) A human-friendly description.

• isRestricted (boolean) – (optional in body) This type of Endpoint can be created, updated or deleted by admin only. If a restricted Endpoint is consumed in a pipeline, and that pipeline is executed by a non-admin user, then the execution will fail at the task which is consuming this restricted Endpoint. Only admin can then resume this pipeline to make it progress.

• project (string) – (optional in body) The project this entity belongs to.

async idem_vra.exec.vra.pipeline.endpoints.delete_endpoint_by_id_using_delete(hub, ctx, p_id, **kwargs)

Delete an Endpoint by id Delete an Endpoint with the given id Performs DELETE /codestream/api/endpoints/{id}

Parameters:

• p_id (string) – (required in path) The ID of the Endpoint

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.endpoints.delete_endpoint_by_name_using_delete(hub, ctx, p_name, p_project, **kwargs)

Delete an Endpoint by project and name Delete an Endpoint with the given name Performs DELETE /codestream/api/endpoints/{project}/{name}

Parameters:

• p_name (string) – (required in path) The name of the Endpoint

• p_project (string) – (required in path) The project the Endpoint belongs to

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.endpoints.get_all_endpoints_using_get(hub, ctx, **kwargs)

Get all Endpoints Get all Endpoints with specified paging and filter parameters Performs GET /codestream/api/endpoints

Parameters:

• filter (string) – (optional in query) To list Endpoints with OData like filter

• orderby (string) – (optional in query) Order by attribute

• skip (string) – (optional in query) To skip ‘n’ Endpoints for listing

• top (string) – (optional in query) To list top ‘n’ Endpoints for listing

• page (string) – (optional in query) To select ‘n’th page for listing

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.endpoints.get_endpoint_by_id_using_get(hub, ctx, p_id, **kwargs)

Get an Endpoint Get an Endpoint with the given id Performs GET /codestream/api/endpoints/{id}

Parameters:

• p_id (string) – (required in path) The ID of the Endpoint

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.endpoints.get_endpoint_by_name_using_get(hub, ctx, p_name, p_project, **kwargs)

Get an Endpoint by project and name Get an Endpoint with the given project and name Performs GET /codestream/api/endpoints/{project}/{name}

Parameters:

• p_name (string) – (required in path) The name of the Endpoint

• p_project (string) – (required in path) The project the Endpoint belongs to

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.endpoints.get_endpoint_properties_using_get(hub, ctx, p_type, **kwargs)

Get endpoint properties Get endpoint properties with the given endpoint type Performs GET /codestream/api/endpoint-tiles/{type}

Parameters:

• p_type (string) – (required in path) type

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.endpoints.get_endpoint_tiles_using_get(hub, ctx, **kwargs)

Get all endpoint tiles Get all supported endpoint tiles Performs GET /codestream/api/endpoint-tiles

Parameters:

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.endpoints.get_using_get(hub, ctx, q_url, **kwargs)

Get endpoint certificate Get endpoint certificate chain for validation Performs GET /codestream/api/endpoint-certificate

Parameters:

• q_url (string) – (required in query) URL of the server

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.endpoints.update_endpoint_by_id_using_put(hub, ctx, p_id, name, properties, type, **kwargs)

Update an Endpoint by id Update an Endpoint with the given id Performs PUT /codestream/api/endpoints/{id}

Parameters:

• p_id (string) – (required in path) The ID of the Endpoint

• name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

• properties (object) – (required in body) Endpoint specific properties

• type (string) – (required in body) The type of this Endpoint instance.

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) A human-friendly description.

• isRestricted (boolean) – (optional in body) This type of Endpoint can be created, updated or deleted by admin only. If a restricted Endpoint is consumed in a pipeline, and that pipeline is executed by a non-admin user, then the execution will fail at the task which is consuming this restricted Endpoint. Only admin can then resume this pipeline to make it progress.

• project (string) – (optional in body) The project this entity belongs to.

async idem_vra.exec.vra.pipeline.endpoints.update_endpoint_by_name_using_put(hub, ctx, p_name, p_project, name, properties, type, **kwargs)

Update an Endpoint by project and name Update an Endpoint with the given project and name Performs PUT /codestream/api/endpoints/{project}/{name}

Parameters:

• p_name (string) – (required in path) The name of the Endpoint

• p_project (string) – (required in path) The project the Endpoint belongs to

• name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

• properties (object) – (required in body) Endpoint specific properties

• type (string) – (required in body) The type of this Endpoint instance.

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) A human-friendly description.

• isRestricted (boolean) – (optional in body) This type of Endpoint can be created, updated or deleted by admin only. If a restricted Endpoint is consumed in a pipeline, and that pipeline is executed by a non-admin user, then the execution will fail at the task which is consuming this restricted Endpoint. Only admin can then resume this pipeline to make it progress.

• project (string) – (optional in body) The project this entity belongs to.

async idem_vra.exec.vra.pipeline.endpoints.validate_endpoint_using_post(hub, ctx, name, properties, type, **kwargs)

Validate endpoint Validates the given endpoint Performs POST /codestream/api/endpoint-validation

Parameters:

• name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

• properties (object) – (required in body) Endpoint specific properties

• type (string) – (required in body) The type of this Endpoint instance.

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) A human-friendly description.

• id (string) – (optional in body) id of the endpoint, if already present

• isRestricted (boolean) – (optional in body) This type of Endpoint can be created, updated or deleted by admin only. If a restricted Endpoint is consumed in a pipeline, and that pipeline is executed by a non-admin user, then the execution will fail at the task which is consuming this restricted Endpoint. Only admin can then resume this pipeline to make it progress.

• project (string) – (optional in body) The project this entity belongs to.