Skip to content

Api Documentation

Jump to bottom
Charles d'Avernas edited this page Aug 13, 2024 · 2 revisions

This document provides an overview of the API endpoints available for managing resources using Synapse. The API is designed to interact with resources such as correlations, using standard HTTP methods.

Table of Contents

Correlations API

Get Correlation

Retrieves a correlation with the specified name and namespace.

Endpoint: GET /api/v1/correlations/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the correlation.
namespace string yes The namespace the correlation belongs to.

Responses

  • 200 OK: Returns the requested correlation.
  • 400 Bad Request: Invalid request or validation problem.

List Correlations

Lists correlations matching the optional label selectors.

Endpoint: GET /api/v1/correlations

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors.

Responses

  • 200 OK: Returns a collection of correlations.
  • 400 Bad Request: Invalid label selector.

List Correlations by Namespace

Lists correlations within the specified namespace.

Endpoint: GET /api/v1/correlations/{namespace}

Parameters

Name Type Required Description
namespace string yes The namespace to list correlations from.
labelSelector string no A comma-separated list of label selectors.

Responses

  • 200 OK: Returns a collection of correlations.
  • 400 Bad Request: Invalid label selector.

List Correlations with Pagination

Lists correlations with optional pagination and label selectors.

Endpoint: GET /api/v1/correlations/list

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors.
maxResults ulong no Maximum number of results to return.
continuationToken string no Token to continue listing from a previous result.

Responses

  • 200 OK: Returns a collection of correlations.
  • 400 Bad Request: Invalid label selector.

List Correlations by Namespace with Pagination

Lists correlations within a specified namespace with optional pagination and label selectors.

Endpoint: GET /api/v1/correlations/{namespace}/list

Parameters

Name Type Required Description
namespace string yes The namespace to list correlations from.
labelSelector string no A comma-separated list of label selectors.
maxResults ulong no Maximum number of results to return.
continuationToken string no Token to continue listing from a previous result.

Responses

  • 200 OK: Returns a collection of correlations.
  • 400 Bad Request: Invalid label selector.

Watch Correlations

Watches for changes to correlations matching the optional label selectors.

Endpoint: GET /api/v1/correlations/watch

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors.

Responses

  • 200 OK: Returns a stream of watch events.
  • 400 Bad Request: Invalid label selector.

Watch Correlations by Namespace

Watches for changes to correlations within the specified namespace.

Endpoint: GET /api/v1/correlations/{namespace}/watch

Parameters

Name Type Required Description
namespace string yes The namespace to watch correlations in.
labelSelector string no A comma-separated list of label selectors.

Responses

  • 200 OK: Returns a stream of watch events.
  • 400 Bad Request: Invalid label selector.

Watch Correlations Using SSE

Watches for changes to correlations within the specified namespace and uses Server-Sent Events (SSE) for streaming.

Endpoint: GET /api/v1/correlations/{namespace}/watch/sse

Parameters

Name Type Required Description
namespace string yes The namespace to watch correlations in.
labelSelector string no A comma-separated list of label selectors.

Responses

  • 200 OK: Returns a stream of watch events via SSE.
  • 400 Bad Request: Invalid label selector.

Monitor Correlation

Monitors a specific correlation for changes.

Endpoint: GET /api/v1/correlations/{namespace}/{name}/monitor

Parameters

Name Type Required Description
name string yes The name of the correlation.
namespace string yes The namespace the correlation belongs to.

Responses

  • 200 OK: Returns a stream of watch events.
  • 400 Bad Request: Invalid request.

Monitor Correlation Using SSE

Monitors a specific correlation for changes and uses SSE for streaming.

Endpoint: GET /api/v1/correlations/{namespace}/{name}/monitor/sse

Parameters

Name Type Required Description
name string yes The name of the correlation.
namespace string yes The namespace the correlation belongs to.

Responses

  • 200 OK: Returns a stream of watch events via SSE.
  • 400 Bad Request: Invalid request.

Patch Correlation

Applies a patch to a specific correlation.

Endpoint: PATCH /api/v1/correlations/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the correlation to patch.
namespace string yes The namespace the correlation belongs to.
patch Patch yes The patch to apply.
resourceVersion string no The expected correlation version for optimistic concurrency.

Responses

  • 200 OK: Returns the patched correlation.
  • 400 Bad Request: Invalid request or validation problem.

Patch Correlation Status

Applies a patch to a specific correlation's status.

Endpoint: PATCH /api/v1/correlations/{namespace}/{name}/status

Parameters

Name Type Required Description
name string yes The name of the correlation to patch.
namespace string yes The namespace the correlation belongs to.
patch Patch yes The patch to apply.
resourceVersion string no The expected correlation version for optimistic concurrency.

Responses

  • 200 OK: Returns the patched correlation.
  • 400 Bad Request: Invalid request or validation problem.

Delete Correlation

Deletes a specific correlation.

Endpoint: DELETE /api/v1/correlations/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the correlation to delete.
namespace string yes The namespace the correlation belongs to.

Responses

  • 200 OK: Returns the deleted correlation.
  • 400 Bad Request: Invalid request or validation problem.

Correlators API

List Correlators

Lists all correlators with optional filtering.

Endpoint: GET /api/v1/correlators

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors to filter the correlators.

Responses

  • 200 OK: Returns a collection of correlators.
  • 400 Bad Request: Invalid label selector or request parameters.

Get Correlator

Retrieves a correlator with the specified ID.

Endpoint: GET /api/v1/correlators/{id}

Parameters

Name Type Required Description
id string yes The ID of the correlator to retrieve.

Responses

  • 200 OK: Returns the requested correlator.
  • 404 Not Found: The correlator with the specified ID does not exist.
  • 400 Bad Request: Invalid ID format.

List Correlators by Namespace

Lists correlators within a specific namespace with optional filtering.

Endpoint: GET /api/v1/correlators/{namespace}

Parameters

Name Type Required Description
namespace string yes The namespace to filter the correlators by.
labelSelector string no A comma-separated list of label selectors to filter the correlators.

Responses

  • 200 OK: Returns a collection of correlators within the specified namespace.
  • 400 Bad Request: Invalid namespace or label selector.

List Correlators with Pagination

Lists correlators with optional pagination and filtering.

Endpoint: GET /api/v1/correlators/list

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors to filter the correlators.
maxResults ulong no The maximum number of results to return.
continuationToken string no A token used to continue enumerating through matches.

Responses

  • 200 OK: Returns a paginated collection of correlators.
  • 400 Bad Request: Invalid pagination parameters or label selector.

List Correlators by Namespace with Pagination

Lists correlators within a specific namespace with pagination.

Endpoint: GET /api/v1/correlators/{namespace}/list

Parameters

Name Type Required Description
namespace string yes The namespace to filter the correlators by.
labelSelector string no A comma-separated list of label selectors to filter the correlators.
maxResults ulong no The maximum number of results to return.
continuationToken string no A token used to continue enumerating through matches.

Responses

  • 200 OK: Returns a paginated collection of correlators within the specified namespace.
  • 400 Bad Request: Invalid parameters or namespace.

Watch Correlators

Streams real-time updates of correlators based on the label selectors.

Endpoint: GET /api/v1/correlators/watch

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors to filter the correlators.

Responses

  • 200 OK: Streams real-time updates of correlators.
  • 400 Bad Request: Invalid label selector or request parameters.

Watch Correlators by Namespace

Streams real-time updates of correlators within a specific namespace.

Endpoint: GET /api/v1/correlators/{namespace}/watch

Parameters

Name Type Required Description
namespace string yes The namespace to filter the correlators by.
labelSelector string no A comma-separated list of label selectors to filter the correlators.

Responses

  • 200 OK: Streams real-time updates of correlators within the specified namespace.
  • 400 Bad Request: Invalid namespace or label selector.

Watch Correlators Using SSE

Streams real-time updates of correlators using Server-Sent Events (SSE).

Endpoint: GET /api/v1/correlators/watch/sse

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors to filter the correlators.

Responses

  • 200 OK: Streams real-time updates using SSE.
  • 400 Bad Request: Invalid label selector or request parameters.

Monitor Correlator

Monitors a correlator and retrieves its real-time status.

Endpoint: GET /api/v1/correlators/{id}/monitor

Parameters

Name Type Required Description
id string yes The ID of the correlator to monitor.

Responses

  • 200 OK: Returns the real-time status of the requested correlator.
  • 404 Not Found: The correlator with the specified ID does not exist.
  • 400 Bad Request: Invalid ID format.

Monitor Correlator Using SSE

Monitors a correlator using Server-Sent Events (SSE) to receive real-time updates.

Endpoint: GET /api/v1/correlators/{id}/monitor/sse

Parameters

Name Type Required Description
id string yes The ID of the correlator to monitor.

Responses

  • 200 OK: Streams real-time updates using SSE for the requested correlator.
  • 404 Not Found: The correlator with the specified ID does not exist.
  • 400 Bad Request: Invalid ID format.

Patch Correlator

Updates specific fields of a correlator.

Endpoint: PATCH /api/v1/correlators/{id}

Parameters

Name Type Required Description
id string yes The ID of the correlator to update.
body object yes The fields to update in the correlator.

Responses

  • 200 OK: Returns the updated correlator.
  • 404 Not Found: The correlator with the specified ID does not exist.
  • 400 Bad Request: Invalid fields or request format.

Patch Correlator Status

Updates the status of a correlator.

Endpoint: PATCH /api/v1/correlators/{id}/status

Parameters

Name Type Required Description
id string yes The ID of the correlator to update.
status string yes The new status for the correlator.

Responses

  • 200 OK: Returns the updated status of the correlator.
  • 404 Not Found: The correlator with the specified ID does not exist.
  • 400 Bad Request: Invalid status or request format.

Delete Correlator

Deletes a correlator with the specified ID.

Endpoint: DELETE /api/v1/correlators/{id}

Parameters

Name Type Required Description
id string yes The ID of the correlator to delete.

Responses

  • 204 No Content: The correlator was successfully deleted.
  • 404 Not Found: The correlator with the specified ID does not exist.
  • 400 Bad Request: Invalid ID format.

Create Document

Creates a new document.

Endpoint: POST /api/v1/documents

Parameters

Name Type Required Description
document object yes The document data to be created.

Responses

  • 201 Created: Returns the created document.
  • 400 Bad Request: Invalid document data or request format.

Get Document

Retrieves a document with the specified ID.

Endpoint: GET /api/v1/documents/{id}

Parameters

Name Type Required Description
id string yes The ID of the document to retrieve.

Responses

  • 200 OK: Returns the requested document.
  • 404 Not Found: The document with the specified ID does not exist.
  • 400 Bad Request: Invalid ID format.

Update Document

Updates the contents of the document with the specified ID.

Endpoint: PUT /api/v1/documents/{id}

Parameters

Name Type Required Description
id string yes The ID of the document to update.
content object yes The document's updated content.

Responses

  • 200 OK: Returns the updated document.
  • 400 Bad Request: Invalid document ID or update content.

Namespaces API

Get Namespace

Retrieves a namespace with the specified name.

Endpoint: GET /api/v1/namespaces/{name}

Parameters

Name Type Required Description
name string yes The name of the namespace to retrieve.

Responses

  • 200 OK: Returns the requested namespace.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: The namespace with the specified name does not exist.

List Namespaces

Lists matching namespaces based on label selectors.

Endpoint: GET /api/v1/namespaces

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Returns a collection of matching namespaces.
  • 400 Bad Request: Invalid label selectors or request format.

List Namespaces with Pagination

Lists matching namespaces with pagination support.

Endpoint: GET /api/v1/namespaces/list

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.
maxResults ulong no The maximum number of results to list at once.
continuationToken string no A token used to continue enumerating through matches.

Responses

  • 200 OK: Returns a paginated collection of matching namespaces.
  • 400 Bad Request: Invalid label selectors, continuation token, or request format.

Watch Namespaces

Watches for changes in matching namespaces.

Endpoint: GET /api/v1/namespaces/watch

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Returns a stream of namespace watch events.
  • 400 Bad Request: Invalid label selectors or request format.

Watch Namespaces Using SSE

Watches for changes in matching namespaces and streams updates using Server-Sent Events (SSE).

Endpoint: GET /api/v1/namespaces/watch/sse

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Streams namespace watch events in SSE format.
  • 400 Bad Request: Invalid label selectors or request format.

Monitor Namespace

Monitors a specific namespace for changes.

Endpoint: GET /api/v1/namespaces/{name}/monitor

Parameters

Name Type Required Description
name string yes The name of the namespace to monitor.

Responses

  • 200 OK: Returns a stream of namespace monitor events.
  • 404 Not Found: The namespace with the specified name does not exist.

Monitor Namespace Using SSE

Monitors a specific namespace and streams updates using Server-Sent Events (SSE).

Endpoint: GET /api/v1/namespaces/{name}/monitor/sse

Parameters

Name Type Required Description
name string yes The name of the namespace to monitor.

Responses

  • 200 OK: Streams namespace monitor events in SSE format.
  • 404 Not Found: The namespace with the specified name does not exist.

Patch Namespace

Patches the specified namespace.

Endpoint: PATCH /api/v1/namespaces/{name}

Parameters

Name Type Required Description
name string yes The name of the namespace to patch.
patch object yes The patch to apply to the namespace.
resourceVersion string no The expected namespace version for optimistic concurrency.

Responses

  • 200 OK: Returns the patched namespace.
  • 400 Bad Request: Invalid patch data or request format.
  • 404 Not Found: The namespace with the specified name does not exist.

Patch Namespace Status

Patches the status of the specified namespace.

Endpoint: PATCH /api/v1/namespaces/{name}/status

Parameters

Name Type Required Description
name string yes The name of the namespace to patch the status of.
patch object yes The patch to apply to the namespace's status.
resourceVersion string no The expected namespace version for optimistic concurrency.

Responses

  • 200 OK: Returns the namespace with the updated status.
  • 400 Bad Request: Invalid patch data or request format.
  • 404 Not Found: The namespace with the specified name does not exist.

Delete Namespace

Deletes the namespace with the specified name.

Endpoint: DELETE /api/v1/namespaces/{name}

Parameters

Name Type Required Description
name string yes The name of the namespace to delete.

Responses

  • 200 OK: Returns the deleted namespace.
  • 404 Not Found: The namespace with the specified name does not exist.
  • 400 Bad Request: Invalid request or validation problem.

Operators API

Get Operator

Retrieves an operator with the specified name and namespace.

Endpoint: GET /api/v1/operators/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the operator.
namespace string yes The namespace the operator belongs to.

Responses

  • 200 OK: Returns the requested operator.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: The operator with the specified name and namespace does not exist.

List Operators

Lists matching operators based on optional label selectors.

Endpoint: GET /api/v1/operators

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Returns a collection of matching operators.
  • 400 Bad Request: Invalid label selectors or request format.

List Operators by Namespace

Lists operators in a specified namespace.

Endpoint: GET /api/v1/operators/{namespace}

Parameters

Name Type Required Description
namespace string yes The namespace to list operators in.
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Returns a collection of operators in the specified namespace.
  • 400 Bad Request: Invalid label selectors or request format.

List Operators with Pagination

Lists matching operators with pagination support.

Endpoint: GET /api/v1/operators/list

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.
maxResults ulong no The maximum number of results to list at once.
continuationToken string no A token used to continue enumerating through matches.

Responses

  • 200 OK: Returns a paginated collection of matching operators.
  • 400 Bad Request: Invalid label selectors, continuation token, or request format.

List Operators by Namespace with Pagination

Lists operators in a specified namespace with pagination support.

Endpoint: GET /api/v1/operators/{namespace}/list

Parameters

Name Type Required Description
namespace string yes The namespace to list operators in.
labelSelector string no A comma-separated list of label selectors, if any.
maxResults ulong no The maximum number of results to list at once.
continuationToken string no A token used to continue enumerating through matches.

Responses

  • 200 OK: Returns a paginated collection of operators in the specified namespace.
  • 400 Bad Request: Invalid label selectors, continuation token, or request format.

Watch Operators

Watches for changes in matching operators.

Endpoint: GET /api/v1/operators/watch

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Returns a stream of operator watch events.
  • 400 Bad Request: Invalid label selectors or request format.

Watch Operators by Namespace

Watches for changes in operators within a specified namespace.

Endpoint: GET /api/v1/operators/{namespace}/watch

Parameters

Name Type Required Description
namespace string yes The namespace to watch operators in.
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Returns a stream of operator watch events in the specified namespace.
  • 400 Bad Request: Invalid label selectors or request format.

Watch Operators Using SSE

Watches for changes in matching operators and streams updates using Server-Sent Events (SSE).

Endpoint: GET /api/v1/operators/watch/sse

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Streams operator watch events in SSE format.
  • 400 Bad Request: Invalid label selectors or request format.

Monitor Operator

Monitors a specific operator for changes.

Endpoint: GET /api/v1/operators/{namespace}/{name}/monitor

Parameters

Name Type Required Description
name string yes The name of the operator to monitor.
namespace string yes The namespace of the operator to monitor.

Responses

  • 200 OK: Returns a stream of operator monitor events.
  • 404 Not Found: The operator with the specified name and namespace does not exist.

Monitor Operator Using SSE

Monitors a specific operator and streams updates using Server-Sent Events (SSE).

Endpoint: GET /api/v1/operators/{namespace}/{name}/monitor/sse

Parameters

Name Type Required Description
name string yes The name of the operator to monitor.
namespace string yes The namespace of the operator to monitor.

Responses

  • 200 OK: Streams operator monitor events in SSE format.
  • 404 Not Found: The operator with the specified name and namespace does not exist.

Patch Operator

Patches the specified operator.

Endpoint: PATCH /api/v1/operators/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the operator to patch.
namespace string yes The namespace of the operator to patch.
patch object yes The patch to apply to the operator.
resourceVersion string no The expected operator version for optimistic concurrency.

Responses

  • 200 OK: Returns the patched operator.
  • 400 Bad Request: Invalid patch data or request format.
  • 404 Not Found: The operator with the specified name and namespace does not exist.

Patch Operator Status

Patches the status of the specified operator.

Endpoint: PATCH /api/v1/operators/{namespace}/{name}/status

Parameters

Name Type Required Description
name string yes The name of the operator to patch the status of.
namespace string yes The namespace of the operator to patch the status of.
patch object yes The patch to apply to the operator's status.
resourceVersion string no The expected operator version for optimistic concurrency.

Responses

  • 200 OK: Returns the operator with the updated status.
  • 400 Bad Request: Invalid patch data or request format.
  • 404 Not Found: The operator with the specified name and namespace does not exist.

Delete Operator

Deletes the operator with the specified name and namespace.

Endpoint: DELETE /api/v1/operators/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the operator to delete.
namespace string yes The namespace of the operator to delete.

Responses

  • 200 OK: Returns the deleted operator.
  • 404 Not Found: The operator with the specified name and namespace does not exist.
  • 400 Bad Request: Invalid request or validation problem.

Service Accounts API

Get Service Account

Retrieves a service account with the specified name and namespace.

Endpoint: GET /api/v1/service-accounts/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the service account.
namespace string yes The namespace the service account belongs to.

Responses

  • 200 OK: Returns the requested service account.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: The service account with the specified name and namespace does not exist.

List Service Accounts

Lists matching service accounts based on optional label selectors.

Endpoint: GET /api/v1/service-accounts

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Returns a collection of matching service accounts.
  • 400 Bad Request: Invalid label selectors or request format.

List Service Accounts by Namespace

Lists service accounts in a specified namespace.

Endpoint: GET /api/v1/service-accounts/{namespace}

Parameters

Name Type Required Description
namespace string yes The namespace to list service accounts in.
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Returns a collection of service accounts in the specified namespace.
  • 400 Bad Request: Invalid label selectors or request format.

List Service Accounts with Pagination

Lists matching service accounts with pagination support.

Endpoint: GET /api/v1/service-accounts/list

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.
maxResults ulong no The maximum number of results to list at once.
continuationToken string no A token used to continue enumerating through matches.

Responses

  • 200 OK: Returns a paginated collection of matching service accounts.
  • 400 Bad Request: Invalid label selectors, pagination parameters, or request format.

Watch Service Accounts

Watches for changes in service accounts based on optional label selectors.

Endpoint: GET /api/v1/service-accounts/watch

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Returns a stream of events indicating changes to service accounts.
  • 400 Bad Request: Invalid label selectors or request format.

Watch Service Accounts by Namespace

Watches for changes in service accounts within a specified namespace.

Endpoint: GET /api/v1/service-accounts/{namespace}/watch

Parameters

Name Type Required Description
namespace string yes The namespace to watch for service accounts.
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Returns a stream of events indicating changes to service accounts in the specified namespace.
  • 400 Bad Request: Invalid label selectors or request format.

Watch Service Accounts Using SSE

Streams updates for service accounts using Server-Sent Events (SSE).

Endpoint: GET /api/v1/service-accounts/watch/sse

Parameters

Name Type Required Description
labelSelector string no A comma-separated list of label selectors, if any.

Responses

  • 200 OK: Streams updates for service accounts as Server-Sent Events.
  • 400 Bad Request: Invalid label selectors or request format.

Monitor Service Account

Monitors a specific service account for changes.

Endpoint: GET /api/v1/service-accounts/{name}/monitor

Parameters

Name Type Required Description
name string yes The name of the service account to monitor.

Responses

  • 200 OK: Returns a stream of events indicating changes to the specified service account.
  • 404 Not Found: The service account with the specified name does not exist.

Monitor Service Account Using SSE

Streams updates for a specific service account using Server-Sent Events (SSE).

Endpoint: GET /api/v1/service-accounts/{name}/monitor/sse

Parameters

Name Type Required Description
name string yes The name of the service account to monitor.

Responses

  • 200 OK: Streams updates for the specified service account as Server-Sent Events.
  • 404 Not Found: The service account with the specified name does not exist.

Patch Service Account

Patches the specified service account with updated data.

Endpoint: PATCH /api/v1/service-accounts/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the service account to patch.
namespace string yes The namespace the service account belongs to.
patch object yes The patch to apply to the service account.
resourceVersion string no The expected resource version, if any, used for optimistic concurrency.

Responses

  • 200 OK: Returns the updated service account.
  • 400 Bad Request: Invalid patch data or request format.

Patch Service Account Status

Patches the status of the specified service account.

Endpoint: PATCH /api/v1/service-accounts/{namespace}/{name}/status

Parameters

Name Type Required Description
name string yes The name of the service account to patch.
namespace string yes The namespace the service account belongs to.
patch object yes The patch to apply to the service account's status.
resourceVersion string no The expected resource version, if any, used for optimistic concurrency.

Responses

  • 200 OK: Returns the updated service account status.
  • 400 Bad Request: Invalid patch data or request format.

Delete Service Account

Deletes the service account with the specified name and namespace.

Endpoint: DELETE /api/v1/service-accounts/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the service account to delete.
namespace string yes The namespace the service account belongs to.

Responses

  • 200 OK: Returns a confirmation of the deletion.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: The service account with the specified name and namespace does not exist.

Users API

Get User Profile

Retrieves the profile of the current user.

Endpoint: GET /api/v1/users/profile

Parameters

None.

Responses

  • 200 OK: Returns the current user's profile.
  • 401 Unauthorized: Authentication is required to access this resource.

Workflow Instances API

List Workflow Instances

Lists all workflow instances within a specified namespace.

Endpoint: GET /api/v1/workflow-instances/{namespace}

Parameters

Name Type Required Description
namespace string yes The namespace to list workflow instances from.

Responses

  • 200 OK: Returns a list of workflow instances.
  • 400 Bad Request: Invalid request or validation problem.

Get Workflow Instance

Retrieves a workflow instance with the specified name and namespace.

Endpoint: GET /api/v1/workflow-instances/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the workflow instance.
namespace string yes The namespace the workflow instance belongs to.

Responses

  • 200 OK: Returns the requested workflow instance.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: Workflow instance not found.

List Workflow Instances by Namespace

Lists all workflow instances within a specified namespace.

Endpoint: GET /api/v1/workflow-instances/{namespace}

Parameters

Name Type Required Description
namespace string yes The namespace to list workflow instances from.

Responses

  • 200 OK: Returns a list of workflow instances.
  • 400 Bad Request: Invalid request or validation problem.

List Workflow Instances with Pagination

Lists workflow instances within a specified namespace with pagination support.

Endpoint: GET /api/v1/workflow-instances/{namespace}/list

Parameters

Name Type Required Description
namespace string yes The namespace to list workflow instances from.
maxResults number no The maximum number of results to return.
continuationToken string no Token for continuing through paginated results.

Responses

  • 200 OK: Returns a paginated list of workflow instances.
  • 400 Bad Request: Invalid request or validation problem.

List Workflow Instances by Namespace with Pagination

Lists workflow instances within a specified namespace with pagination support.

Endpoint: GET /api/v1/workflow-instances/{namespace}/list

Parameters

Name Type Required Description
namespace string yes The namespace to list workflow instances from.
maxResults number no The maximum number of results to return.
continuationToken string no Token for continuing through paginated results.

Responses

  • 200 OK: Returns a paginated list of workflow instances.
  • 400 Bad Request: Invalid request or validation problem.

Watch Workflow Instances

Streams updates for workflow instances within a specified namespace.

Endpoint: GET /api/v1/workflow-instances/{namespace}/watch

Parameters

Name Type Required Description
namespace string yes The namespace to watch workflow instances from.

Responses

  • 200 OK: Returns a stream of workflow instance updates.
  • 400 Bad Request: Invalid request or validation problem.

Watch Workflow Instances by Namespace

Streams updates for workflow instances within a specified namespace.

Endpoint: GET /api/v1/workflow-instances/{namespace}/watch

Parameters

Name Type Required Description
namespace string yes The namespace to watch workflow instances from.

Responses

  • 200 OK: Returns a stream of workflow instance updates.
  • 400 Bad Request: Invalid request or validation problem.

Watch Workflow Instances Using SSE

Streams updates for workflow instances within a specified namespace using Server-Sent Events (SSE).

Endpoint: GET /api/v1/workflow-instances/{namespace}/watch/sse

Parameters

Name Type Required Description
namespace string yes The namespace to watch workflow instances from.

Responses

  • 200 OK: Returns a stream of workflow instance updates in SSE format.
  • 400 Bad Request: Invalid request or validation problem.

Monitor Workflow Instance

Monitors a specific workflow instance within a namespace.

Endpoint: GET /api/v1/workflow-instances/{namespace}/{name}/monitor

Parameters

Name Type Required Description
name string yes The name of the workflow instance to monitor.
namespace string yes The namespace the workflow instance belongs to.

Responses

  • 200 OK: Returns a stream of monitoring data for the workflow instance.
  • 400 Bad Request: Invalid request or validation problem.

Monitor Workflow Instance Using SSE

Monitors a specific workflow instance within a namespace using Server-Sent Events (SSE).

Endpoint: GET /api/v1/workflow-instances/{namespace}/{name}/monitor/sse

Parameters

Name Type Required Description
name string yes The name of the workflow instance to monitor.
namespace string yes The namespace the workflow instance belongs to.

Responses

  • 200 OK: Returns a stream of monitoring data for the workflow instance in SSE format.
  • 400 Bad Request: Invalid request or validation problem.

Patch Workflow Instance

Patches a specific workflow instance within a namespace.

Endpoint: PATCH /api/v1/workflow-instances/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the workflow instance to patch.
namespace string yes The namespace the workflow instance belongs to.
patch object yes The patch details for updating the workflow instance.
resourceVersion string no The expected resource version for optimistic concurrency.

Responses

  • 200 OK: Returns the updated workflow instance.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: Workflow instance not found.

Patch Workflow Instance Status

Patches the status of a specific workflow instance within a namespace.

Endpoint: PATCH /api/v1/workflow-instances/{namespace}/{name}/status

Parameters

Name Type Required Description
name string yes The name of the workflow instance to patch the status of.
namespace string yes The namespace the workflow instance belongs to.
patch object yes The patch details for updating the workflow instance's status.
resourceVersion string no The expected resource version for optimistic concurrency.

Responses

  • 200 OK: Returns the updated workflow instance with the new status.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: Workflow instance not found.

Delete Workflow Instance

Deletes a specific workflow instance within a namespace.

Endpoint: DELETE /api/v1/workflow-instances/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the workflow instance to delete.
namespace string yes The namespace the workflow instance belongs to.

Responses

  • 200 OK: Returns a confirmation of the deletion.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: Workflow instance not found.

Workflows API

List Workflows

Lists all workflows within a specified namespace.

Endpoint: GET /api/v1/workflows/{namespace}

Parameters

Name Type Required Description
namespace string yes The namespace to list workflows from.

Responses

  • 200 OK: Returns a list of workflows.
  • 400 Bad Request: Invalid request or validation problem.

Get Workflow

Retrieves a workflow with the specified name and namespace.

Endpoint: GET /api/v1/workflows/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the workflow.
namespace string yes The namespace the workflow belongs to.

Responses

  • 200 OK: Returns the requested workflow.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: Workflow not found.

List Workflows by Namespace

Lists all workflows within a specified namespace.

Endpoint: GET /api/v1/workflows/{namespace}

Parameters

Name Type Required Description
namespace string yes The namespace to list workflows from.

Responses

  • 200 OK: Returns a list of workflows.
  • 400 Bad Request: Invalid request or validation problem.

List Workflows with Pagination

Lists workflows within a specified namespace with pagination support.

Endpoint: GET /api/v1/workflows/{namespace}/list

Parameters

Name Type Required Description
namespace string yes The namespace to list workflows from.
maxResults number no The maximum number of results to return.
continuationToken string no Token for continuing through paginated results.

Responses

  • 200 OK: Returns a paginated list of workflows.
  • 400 Bad Request: Invalid request or validation problem.

List Workflows by Namespace with Pagination

Lists workflows within a specified namespace with pagination support.

Endpoint: GET /api/v1/workflows/{namespace}/list

Parameters

Name Type Required Description
namespace string yes The namespace to list workflows from.
maxResults number no The maximum number of results to return.
continuationToken string no Token for continuing through paginated results.

Responses

  • 200 OK: Returns a paginated list of workflows.
  • 400 Bad Request: Invalid request or validation problem.

Watch Workflows

Streams updates for workflows within a specified namespace.

Endpoint: GET /api/v1/workflows/{namespace}/watch

Parameters

Name Type Required Description
namespace string yes The namespace to watch workflows from.

Responses

  • 200 OK: Returns a stream of workflow updates.
  • 400 Bad Request: Invalid request or validation problem.

Watch Workflows by Namespace

Streams updates for workflows within a specified namespace.

Endpoint: GET /api/v1/workflows/{namespace}/watch

Parameters

Name Type Required Description
namespace string yes The namespace to watch workflows from.

Responses

  • 200 OK: Returns a stream of workflow updates.
  • 400 Bad Request: Invalid request or validation problem.

Watch Workflows Using SSE

Streams updates for workflows within a specified namespace using Server-Sent Events (SSE).

Endpoint: GET /api/v1/workflows/{namespace}/watch/sse

Parameters

Name Type Required Description
namespace string yes The namespace to watch workflows from.

Responses

  • 200 OK: Returns a stream of workflow updates in SSE format.
  • 400 Bad Request: Invalid request or validation problem.

Monitor Workflow

Monitors a specific workflow within a namespace.

Endpoint: GET /api/v1/workflows/{namespace}/{name}/monitor

Parameters

Name Type Required Description
name string yes The name of the workflow to monitor.
namespace string yes The namespace the workflow belongs to.

Responses

  • 200 OK: Returns a stream of monitoring data for the workflow.
  • 400 Bad Request: Invalid request or validation problem.

Monitor Workflow Using SSE

Monitors a specific workflow within a namespace using Server-Sent Events (SSE).

Endpoint: GET /api/v1/workflows/{namespace}/{name}/monitor/sse

Parameters

Name Type Required Description
name string yes The name of the workflow to monitor.
namespace string yes The namespace the workflow belongs to.

Responses

  • 200 OK: Returns a stream of monitoring data for the workflow in SSE format.
  • 400 Bad Request: Invalid request or validation problem.

Patch Workflow

Patches a specific workflow within a namespace.

Endpoint: PATCH /api/v1/workflows/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the workflow to patch.
namespace string yes The namespace the workflow belongs to.
patch object yes The patch details for updating the workflow.
resourceVersion string no The expected resource version for optimistic concurrency.

Responses

  • 200 OK: Returns the updated workflow.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: Workflow not found.

Patch Workflow Status

Patches the status of a specific workflow within a namespace.

Endpoint: PATCH /api/v1/workflows/{namespace}/{name}/status

Parameters

Name Type Required Description
name string yes The name of the workflow to patch the status of.
namespace string yes The namespace the workflow belongs to.
patch object yes The patch details for updating the workflow's status.
resourceVersion string no The expected resource version for optimistic concurrency.

Responses

  • 200 OK: Returns the updated workflow with the new status.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: Workflow not found.

Delete Workflow

Deletes a specific workflow within a namespace.

Endpoint: DELETE /api/v1/workflows/{namespace}/{name}

Parameters

Name Type Required Description
name string yes The name of the workflow to delete.
namespace string yes The namespace the workflow belongs to.

Responses

  • 200 OK: Returns a confirmation of the deletion.
  • 400 Bad Request: Invalid request or validation problem.
  • 404 Not Found: Workflow not found.

Error Responses

All endpoints may return the following error responses:

  • 400 Bad Request: Invalid request, validation errors, or invalid label selector.
  • 404 Not Found: The specified correlation or namespace was not found.
Clone this wiki locally