---
title: "Update Run"
method: PUT
path: "/api/v1/runs/{run_id}"
tags: ["runs"]
---

# Update Run

`PUT /api/v1/runs/{run_id}`

Updates a run.

Args:
    run_id: ID of the run.
    run_model: Run model to use for the update.

Returns:
    The updated run model.

## Path parameters

- `run_id` string, uuid, required

## Request body

- PipelineRunUpdate — Pipeline run update model.
  - `status` 'initializing' | 'failed' | 'completed' | 'running' | 'cached' — Enum that represents the current status of a step or pipeline run.
  - `end_time` string, date-time, nullable
  - `model_version_id` string, uuid, nullable
  - `add_tags` string[], nullable
  - `remove_tags` string[], nullable

## Response `200`

Successful Response

- PipelineRunResponse — Response model for pipeline runs.
  - `body` PipelineRunResponseBody — Response body for pipeline runs.
    - `created` string, date-time, required
    - `updated` string, date-time, required
    - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
      - `body` UserResponseBody — Response body for users.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `active` boolean
        - `activation_token` string, nullable
        - `full_name` string
        - `email_opted_in` boolean, nullable — `null` if not answered, `true` if agreed, `false` if skipped.
        - `is_service_account` boolean, required
        - `is_admin` boolean, required
      - `metadata` UserResponseMetadata — Response metadata for users.
        - `email` string, nullable
        - `external_user_id` string, uuid, nullable
        - `user_metadata` object
      - `resources` UserResponseResources — Class for all resource models associated with the user entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `status` 'initializing' | 'failed' | 'completed' | 'running' | 'cached', required — Enum that represents the current status of a step or pipeline run.
    - `stack` StackResponse — Response model for stacks.
      - `body` StackResponseBody — Response body for stacks.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
          - `body` UserResponseBody — Response body for users.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `active` boolean
            - `activation_token` string, nullable
            - `full_name` string
            - `email_opted_in` boolean, nullable — `null` if not answered, `true` if agreed, `false` if skipped.
            - `is_service_account` boolean, required
            - `is_admin` boolean, required
          - `metadata` UserResponseMetadata — Response metadata for users.
            - `email` string, nullable
            - `external_user_id` string, uuid, nullable
            - `user_metadata` object
          - `resources` UserResponseResources — Class for all resource models associated with the user entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
      - `metadata` StackResponseMetadata — Response metadata for stacks.
        - `workspace` WorkspaceResponse, required — Response model for workspaces.
          - `body` WorkspaceResponseBody — Response body for workspaces.
            - `created` string, date-time, required
            - `updated` string, date-time, required
          - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces.
            - `description` string
          - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `components` object, required
        - `description` string, nullable
        - `stack_spec_path` string, nullable
        - `labels` object, nullable
      - `resources` StackResponseResources — Class for all resource models associated with the stack entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `pipeline` PipelineResponse — Response model for pipelines.
      - `body` PipelineResponseBody — Response body for pipelines.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
          - `body` UserResponseBody — Response body for users.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `active` boolean
            - `activation_token` string, nullable
            - `full_name` string
            - `email_opted_in` boolean, nullable — `null` if not answered, `true` if agreed, `false` if skipped.
            - `is_service_account` boolean, required
            - `is_admin` boolean, required
          - `metadata` UserResponseMetadata — Response metadata for users.
            - `email` string, nullable
            - `external_user_id` string, uuid, nullable
            - `user_metadata` object
          - `resources` UserResponseResources — Class for all resource models associated with the user entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `latest_run_id` string, uuid, nullable
        - `latest_run_status` 'initializing' | 'failed' | 'completed' | 'running' | 'cached' — Enum that represents the current status of a step or pipeline run.
      - `metadata` PipelineResponseMetadata — Response metadata for pipelines.
        - `workspace` WorkspaceResponse, required — Response model for workspaces.
          - `body` WorkspaceResponseBody — Response body for workspaces.
            - `created` string, date-time, required
            - `updated` string, date-time, required
          - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces.
            - `description` string
          - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `description` string, nullable
      - `resources` PipelineResponseResources — Class for all resource models associated with the pipeline entity.
        - `tags` TagResponse[], required
          - `body` TagResponseBody — Response body for tags.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `color` 'grey' | 'purple' | 'red' | 'green' | 'yellow' | 'orange' | 'lime' | 'teal' | 'turquoise' | 'magenta' | 'blue' — All possible color variants for frontend.
            - `tagged_count` integer, required — The count of resources tagged with this tag.
          - `metadata` BaseResponseMetadata — Base metadata model. Used as a base class for all metadata models associated with responses.
          - `resources` TagResponseResources — Class for all resource models associated with the tag entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required — The unique title of the tag.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `build` PipelineBuildResponse — Response model for pipeline builds.
      - `body` PipelineBuildResponseBody — Response body for pipeline builds.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
          - `body` UserResponseBody — Response body for users.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `active` boolean
            - `activation_token` string, nullable
            - `full_name` string
            - `email_opted_in` boolean, nullable — `null` if not answered, `true` if agreed, `false` if skipped.
            - `is_service_account` boolean, required
            - `is_admin` boolean, required
          - `metadata` UserResponseMetadata — Response metadata for users.
            - `email` string, nullable
            - `external_user_id` string, uuid, nullable
            - `user_metadata` object
          - `resources` UserResponseResources — Class for all resource models associated with the user entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
      - `metadata` PipelineBuildResponseMetadata — Response metadata for pipeline builds.
        - `workspace` WorkspaceResponse, required — Response model for workspaces.
          - `body` WorkspaceResponseBody — Response body for workspaces.
            - `created` string, date-time, required
            - `updated` string, date-time, required
          - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces.
            - `description` string
          - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `pipeline` PipelineResponse — Response model for pipelines.
          - `body` PipelineResponseBody — Response body for pipelines.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
              - …
            - `latest_run_id` string, uuid, nullable
            - `latest_run_status` 'initializing' | 'failed' | 'completed' | 'running' | 'cached' — Enum that represents the current status of a step or pipeline run.
          - `metadata` PipelineResponseMetadata — Response metadata for pipelines.
            - `workspace` WorkspaceResponse, required — Response model for workspaces.
              - …
            - `description` string, nullable
          - `resources` PipelineResponseResources — Class for all resource models associated with the pipeline entity.
            - `tags` TagResponse[], required
              - …
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `stack` StackResponse — Response model for stacks.
          - `body` StackResponseBody — Response body for stacks.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
              - …
          - `metadata` StackResponseMetadata — Response metadata for stacks.
            - `workspace` WorkspaceResponse, required — Response model for workspaces.
              - …
            - `components` object, required
            - `description` string, nullable
            - `stack_spec_path` string, nullable
            - `labels` object, nullable
          - `resources` StackResponseResources — Class for all resource models associated with the stack entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `images` object
        - `zenml_version` string, nullable
        - `python_version` string, nullable
        - `checksum` string, nullable
        - `stack_checksum` string, nullable
        - `is_local` boolean, required
        - `contains_code` boolean, required
      - `resources` PipelineBuildResponseResources — Class for all resource models associated with the pipeline build entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
    - `schedule` ScheduleResponse — Response model for schedules.
      - `body` ScheduleResponseBody — Response body for schedules.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
          - `body` UserResponseBody — Response body for users.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `active` boolean
            - `activation_token` string, nullable
            - `full_name` string
            - `email_opted_in` boolean, nullable — `null` if not answered, `true` if agreed, `false` if skipped.
            - `is_service_account` boolean, required
            - `is_admin` boolean, required
          - `metadata` UserResponseMetadata — Response metadata for users.
            - `email` string, nullable
            - `external_user_id` string, uuid, nullable
            - `user_metadata` object
          - `resources` UserResponseResources — Class for all resource models associated with the user entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `active` boolean, required
        - `cron_expression` string, nullable
        - `start_time` string, date-time, nullable
        - `end_time` string, date-time, nullable
        - `interval_second` string, duration, nullable
        - `catchup` boolean
        - `run_once_start_time` string, date-time, nullable
      - `metadata` ScheduleResponseMetadata — Response metadata for schedules.
        - `workspace` WorkspaceResponse, required — Response model for workspaces.
          - `body` WorkspaceResponseBody — Response body for workspaces.
            - `created` string, date-time, required
            - `updated` string, date-time, required
          - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces.
            - `description` string
          - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `orchestrator_id` string, uuid, nullable, required
        - `pipeline_id` string, uuid, nullable, required
      - `resources` ScheduleResponseResources — Class for all resource models associated with the schedule entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `code_reference` CodeReferenceResponse — Response model for code references.
      - `body` CodeReferenceResponseBody — Response body for code references.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `commit` string, required — The commit of the code reference.
        - `subdirectory` string, required — The subdirectory of the code reference.
        - `code_repository` CodeRepositoryResponse, required — Response model for code repositories.
          - `body` CodeRepositoryResponseBody — Response body for code repositories.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
              - …
            - `source` Source, required — Source specification. A source specifies a module name as well as an optional attribute of that module. These values can be used to import the module and get the value of the attribute inside the module. Example: The source `Source(module="zenml.config.source", attribute="Source")` references the class that this docstring is describing. This class is defined in the `zenml.config.source` module and the name of the attribute is the class name `Source`. Attributes: module: The module name. attribute: Optional name of the attribute inside the module. type: The type of the source.
              - …
            - `logo_url` string, nullable — Optional URL of a logo (png, jpg or svg) for the code repository.
          - `metadata` CodeRepositoryResponseMetadata — Response metadata for code repositories.
            - `workspace` WorkspaceResponse, required — Response model for workspaces.
              - …
            - `config` object, required — Configuration for the code repository.
            - `description` string, nullable — Code repository description.
          - `resources` CodeRepositoryResponseResources — Class for all resource models associated with the code repository entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
      - `metadata` CodeReferenceResponseMetadata — Response metadata for code references.
      - `resources` CodeReferenceResponseResources — Class for all resource models associated with the code reference entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
    - `deployment_id` string, uuid, nullable
    - `trigger_execution` TriggerExecutionResponse — Response model for trigger executions.
      - `body` TriggerExecutionResponseBody — Response body for trigger executions.
        - `created` string, date-time, required
        - `updated` string, date-time, required
      - `metadata` TriggerExecutionResponseMetadata — Response metadata for trigger executions.
        - `event_metadata` object
      - `resources` TriggerExecutionResponseResources — Class for all resource models associated with the trigger entity.
        - `trigger` TriggerResponse, required — Response model for models.
          - `body` TriggerResponseBody — Response body for triggers.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
              - …
            - `action_flavor` string, required
            - `action_subtype` string, required
            - `event_source_flavor` string, nullable
            - `event_source_subtype` string, nullable
            - `is_active` boolean, required
          - `metadata` TriggerResponseMetadata — Response metadata for triggers.
            - `workspace` WorkspaceResponse, required — Response model for workspaces.
              - …
            - `description` string
            - `event_filter` object, nullable
            - `schedule` Schedule — Class for defining a pipeline schedule. Attributes: name: Optional name to give to the schedule. If not set, a default name will be generated based on the pipeline name and the current date and time. cron_expression: Cron expression for the pipeline schedule. If a value for this is set it takes precedence over the start time + interval. start_time: datetime object to indicate when to start the schedule. end_time: datetime object to indicate when to end the schedule. interval_second: datetime timedelta indicating the seconds between two recurring runs for a periodic schedule. catchup: Whether the recurring run should catch up if behind schedule. For example, if the recurring run is paused for a while and re-enabled afterward. If catchup=True, the scheduler will catch up on (backfill) each missed interval. Otherwise, it only schedules the latest interval if more than one interval is ready to be scheduled. Usually, if your pipeline handles backfill internally, you should turn catchup off to avoid duplicate backfill. run_once_start_time: datetime object to indicate when to run the pipeline once. This is useful for one-off runs.
              - …
          - `resources` TriggerResponseResources — Class for all resource models associated with the trigger entity.
            - `action` ActionResponse, required — Response model for actions.
              - …
            - `event_source` EventSourceResponse — Response model for event sources.
              - …
            - `executions` PageTriggerExecutionResponse, required
              - …
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
      - `id` string, uuid, required
      - `permission_denied` boolean
    - `model_version_id` string, uuid, nullable
  - `metadata` PipelineRunResponseMetadata — Response metadata for pipeline runs.
    - `workspace` WorkspaceResponse, required — Response model for workspaces.
      - `body` WorkspaceResponseBody — Response body for workspaces.
        - `created` string, date-time, required
        - `updated` string, date-time, required
      - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces.
        - `description` string
      - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `run_metadata` object
    - `steps` object
    - `config` PipelineConfigurationOutput, required — Pipeline configuration class.
      - `enable_cache` boolean, nullable
      - `enable_artifact_metadata` boolean, nullable
      - `enable_artifact_visualization` boolean, nullable
      - `enable_step_logs` boolean, nullable
      - `settings` object
      - `extra` object
      - `failure_hook_source` Source — Source specification. A source specifies a module name as well as an optional attribute of that module. These values can be used to import the module and get the value of the attribute inside the module. Example: The source `Source(module="zenml.config.source", attribute="Source")` references the class that this docstring is describing. This class is defined in the `zenml.config.source` module and the name of the attribute is the class name `Source`. Attributes: module: The module name. attribute: Optional name of the attribute inside the module. type: The type of the source.
        - `module` string, required
        - `attribute` string, nullable
        - `type` 'user' | 'builtin' | 'internal' | 'distribution_package' | 'code_repository' | 'notebook' | 'unknown', required — Enum representing different types of sources.
      - `success_hook_source` Source — Source specification. A source specifies a module name as well as an optional attribute of that module. These values can be used to import the module and get the value of the attribute inside the module. Example: The source `Source(module="zenml.config.source", attribute="Source")` references the class that this docstring is describing. This class is defined in the `zenml.config.source` module and the name of the attribute is the class name `Source`. Attributes: module: The module name. attribute: Optional name of the attribute inside the module. type: The type of the source.
        - `module` string, required
        - `attribute` string, nullable
        - `type` 'user' | 'builtin' | 'internal' | 'distribution_package' | 'code_repository' | 'notebook' | 'unknown', required — Enum representing different types of sources.
      - `model` Model — Model class to pass into pipeline or step to set it into a model context. name: The name of the model. license: The license under which the model is created. description: The description of the model. audience: The target audience of the model. use_cases: The use cases of the model. limitations: The known limitations of the model. trade_offs: The tradeoffs of the model. ethics: The ethical implications of the model. tags: Tags associated with the model. version: The version name, version number or stage is optional and points model context to a specific version/stage. If skipped new version will be created. save_models_to_registry: Whether to save all ModelArtifacts to Model Registry, if available in active stack. model_version_id: The ID of a specific Model Version, if given - it will override `name` and `version` settings. Used mostly internally.
        - `name` string, required
        - `license` string, nullable
        - `description` string, nullable
        - `audience` string, nullable
        - `use_cases` string, nullable
        - `limitations` string, nullable
        - `trade_offs` string, nullable
        - `ethics` string, nullable
        - `tags` string[], nullable
        - `version` union
          - 'none' | 'staging' | 'production' | 'archived' | 'latest' — All possible stages of a Model Version.
          - integer
          - string
        - `save_models_to_registry` boolean
        - `model_version_id` string, uuid, nullable
        - `suppress_class_validation_warnings` boolean
        - `was_created_in_this_run` boolean
      - `parameters` object, nullable
      - `retry` StepRetryConfig — Retry configuration for a step. Delay is an integer (specified in seconds).
        - `max_retries` integer
        - `delay` integer
        - `backoff` integer
      - `name` string, required
    - `start_time` string, date-time, nullable
    - `end_time` string, date-time, nullable
    - `client_environment` object
    - `orchestrator_environment` object
    - `orchestrator_run_id` string, nullable
    - `code_path` string, nullable
    - `template_id` string, uuid, nullable — Template used for the pipeline run.
  - `resources` PipelineRunResponseResources — Class for all resource models associated with the pipeline run entity.
    - `model_version` ModelVersionResponse — Response model for model versions.
      - `body` ModelVersionResponseBody — Response body for model versions.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
          - `body` UserResponseBody — Response body for users.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `active` boolean
            - `activation_token` string, nullable
            - `full_name` string
            - `email_opted_in` boolean, nullable — `null` if not answered, `true` if agreed, `false` if skipped.
            - `is_service_account` boolean, required
            - `is_admin` boolean, required
          - `metadata` UserResponseMetadata — Response metadata for users.
            - `email` string, nullable
            - `external_user_id` string, uuid, nullable
            - `user_metadata` object
          - `resources` UserResponseResources — Class for all resource models associated with the user entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `stage` string, nullable — The stage of the model version
        - `number` integer, required — The number of the model version
        - `model` ModelResponse, required — Response model for models.
          - `body` ModelResponseBody — Response body for models.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
              - …
            - `tags` TagResponse[], required
              - …
            - `latest_version_name` string, nullable
            - `latest_version_id` string, uuid, nullable
          - `metadata` ModelResponseMetadata — Response metadata for models.
            - `workspace` WorkspaceResponse, required — Response model for workspaces.
              - …
            - `license` string, nullable
            - `description` string, nullable
            - `audience` string, nullable
            - `use_cases` string, nullable
            - `limitations` string, nullable
            - `trade_offs` string, nullable
            - `ethics` string, nullable
            - `save_models_to_registry` boolean
          - `resources` ModelResponseResources — Class for all resource models associated with the model entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `model_artifact_ids` object — Model artifacts linked to the model version
        - `data_artifact_ids` object — Data artifacts linked to the model version
        - `deployment_artifact_ids` object — Deployment artifacts linked to the model version
        - `pipeline_run_ids` object — Pipeline runs linked to the model version
        - `tags` TagResponse[]
          - `body` TagResponseBody — Response body for tags.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `color` 'grey' | 'purple' | 'red' | 'green' | 'yellow' | 'orange' | 'lime' | 'teal' | 'turquoise' | 'magenta' | 'blue' — All possible color variants for frontend.
            - `tagged_count` integer, required — The count of resources tagged with this tag.
          - `metadata` BaseResponseMetadata — Base metadata model. Used as a base class for all metadata models associated with responses.
          - `resources` TagResponseResources — Class for all resource models associated with the tag entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required — The unique title of the tag.
      - `metadata` ModelVersionResponseMetadata — Response metadata for model versions.
        - `workspace` WorkspaceResponse, required — Response model for workspaces.
          - `body` WorkspaceResponseBody — Response body for workspaces.
            - `created` string, date-time, required
            - `updated` string, date-time, required
          - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces.
            - `description` string
          - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `description` string, nullable — The description of the model version
        - `run_metadata` object — Metadata linked to the model version
      - `resources` ModelVersionResponseResources — Class for all resource models associated with the model version entity.
        - `services` PageServiceResponse, required
          - `index` integer, required
          - `max_size` integer, required
          - `total_pages` integer, required
          - `total` integer, required
          - `items` ServiceResponse[], required
            - `body` ServiceResponseBody — Response body for services.
              - …
            - `metadata` ServiceResponseMetadata — Response metadata for services.
              - …
            - `resources` ServiceResponseResources — Class for all resource models associated with the service entity.
            - `id` string, uuid, required
            - `permission_denied` boolean
            - `name` string, required
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, nullable — The name of the model version
    - `tags` TagResponse[], required
      - `body` TagResponseBody — Response body for tags.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `color` 'grey' | 'purple' | 'red' | 'green' | 'yellow' | 'orange' | 'lime' | 'teal' | 'turquoise' | 'magenta' | 'blue' — All possible color variants for frontend.
        - `tagged_count` integer, required — The count of resources tagged with this tag.
      - `metadata` BaseResponseMetadata — Base metadata model. Used as a base class for all metadata models associated with responses.
      - `resources` TagResponseResources — Class for all resource models associated with the tag entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required — The unique title of the tag.
  - `id` string, uuid, required
  - `permission_denied` boolean
  - `name` string, required

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/zenml-io/apis/zenml-2.md) · [All operations](https://skmtc.net/zenml-io/apis/zenml-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenml-io/zenml-2/versions/febb01b8bce3/schema)