---
title: "UpdateOnPremScheduler updates the specified onprem scheduler."
method: PATCH
path: "/v1/namespaces/{object.tenant_meta.namespace}/onprem-schedulers"
tags: ["OnPremSchedulerService"]
---

# UpdateOnPremScheduler updates the specified onprem scheduler.

`PATCH /v1/namespaces/{object.tenant_meta.namespace}/onprem-schedulers`

## Path parameters

- `object.tenant_meta.namespace` string, required

## Request body

- OnPremSchedulerServiceUpdateOnPremSchedulerBody — Request to update an onprem scheduler.
  - `object` object
    - `meta` V1Meta — Common fields for all Endor Labs resources.
      - `annotations` object — Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller.
      - `create_time` string, date-time — Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
      - `created_by` string — Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key.
      - `description` string — Resource description. Must be less than 1024 bytes.
      - `index_data` V1IndexData — IndexData is used to index the resource for search. It's an internal object.
        - `data` string[]
        - `search_score` number, float — search_score is the score of the resource for search. Internal use only.
        - `tenant` string
        - `will_be_deleted_at` string, date-time — Time that the resource will be deleted.
      - `kind` string — Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name().
      - `name` string, required — Resource name. Must be 63 characters or less.
      - `parent_kind` string — Parent object resource kind, for example, Project.
      - `parent_uuid` string — Parent object UUID.
      - `references` object — Map of objects referenced in a query API.
      - `tags` string[] — List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less.
      - `update_time` string, date-time — Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
      - `updated_by` string — Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509.
      - `upsert_time` string, date-time — Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
      - `version` string — Message version.
    - `spec` V1OnPremSchedulerSpec
      - `api_credentials` V1AuthMethodAPICredentials
        - `key` string, required — The identifier of an API key.
        - `secret` string, required — The secret for the specified API key.
      - `azure` V1AuthMethodAzure
        - `enable_managed_identity` boolean — Auth using Azure managed identity for system.
        - `managed_identity_client_id` string, required — The client ID of the Azure managed identity.
      - `connection_status` SpecConnectionStatus
        - `connection_state` 'CONNECTION_STATE_UNSPECIFIED' | 'CONNECTION_STATE_CONNECTED' | 'CONNECTION_STATE_DISCONNECTED'
        - `last_updated` string, date-time
      - `endorctl_config` SpecEndorctlConfig
        - `image` string
        - `max_duration` integer — Maximum duration of an endorctl job in minutes.
        - `tag` string — Default will be set to 'latest'.
      - `gcp` V1AuthMethodGCP
        - `service_account` string, required — Auth using GCP service account.
      - `helm_values` string — Contains the base64 encoded helm values.yaml file.
      - `scheduler_config` SpecSchedulerConfig
        - `image` string
        - `max_running_jobs` integer — Maximum number of endorctl jobs that can be run concurrently.
        - `tag` string — Default will be set to 'latest'.
      - `scheduler_version` string — Contains the version of the scheduler.
      - `use_bazel_cache` boolean — Enables bazel remote cache.
    - `tenant_meta` object — Contains the namespace.
    - `uuid` string — The UUID of the onprem scheduler.
  - `request` V1UpdateRequest — Message used for all update requests.
    - `force` boolean — Force will force the update of the resource if any checks fail.
    - `update_mask` string — Fields to update. Defaults to all fields.

## Response `200`

A successful response.

- V1OnPremScheduler
  - `meta` V1Meta, required — Common fields for all Endor Labs resources.
    - `annotations` object — Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller.
    - `create_time` string, date-time — Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `created_by` string — Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key.
    - `description` string — Resource description. Must be less than 1024 bytes.
    - `index_data` V1IndexData — IndexData is used to index the resource for search. It's an internal object.
      - `data` string[]
      - `search_score` number, float — search_score is the score of the resource for search. Internal use only.
      - `tenant` string
      - `will_be_deleted_at` string, date-time — Time that the resource will be deleted.
    - `kind` string — Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name().
    - `name` string, required — Resource name. Must be 63 characters or less.
    - `parent_kind` string — Parent object resource kind, for example, Project.
    - `parent_uuid` string — Parent object UUID.
    - `references` object — Map of objects referenced in a query API.
    - `tags` string[] — List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less.
    - `update_time` string, date-time — Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `updated_by` string — Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509.
    - `upsert_time` string, date-time — Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `version` string — Message version.
  - `spec` V1OnPremSchedulerSpec, required
    - `api_credentials` V1AuthMethodAPICredentials
      - `key` string, required — The identifier of an API key.
      - `secret` string, required — The secret for the specified API key.
    - `azure` V1AuthMethodAzure
      - `enable_managed_identity` boolean — Auth using Azure managed identity for system.
      - `managed_identity_client_id` string, required — The client ID of the Azure managed identity.
    - `connection_status` SpecConnectionStatus
      - `connection_state` 'CONNECTION_STATE_UNSPECIFIED' | 'CONNECTION_STATE_CONNECTED' | 'CONNECTION_STATE_DISCONNECTED'
      - `last_updated` string, date-time
    - `endorctl_config` SpecEndorctlConfig
      - `image` string
      - `max_duration` integer — Maximum duration of an endorctl job in minutes.
      - `tag` string — Default will be set to 'latest'.
    - `gcp` V1AuthMethodGCP
      - `service_account` string, required — Auth using GCP service account.
    - `helm_values` string — Contains the base64 encoded helm values.yaml file.
    - `scheduler_config` SpecSchedulerConfig
      - `image` string
      - `max_running_jobs` integer — Maximum number of endorctl jobs that can be run concurrently.
      - `tag` string — Default will be set to 'latest'.
    - `scheduler_version` string — Contains the version of the scheduler.
    - `use_bazel_cache` boolean — Enables bazel remote cache.
  - `tenant_meta` V1TenantMeta, required — Tenant related data for the tenant containing the resource.
    - `namespace` string, required — Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app".
  - `uuid` string — The UUID of the onprem scheduler.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/endorlabs/apis/endor-labs-rest-api-reference.md) · [All operations](https://skmtc.net/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/endorlabs/endor-labs-rest-api-reference/revisions/2fe1f84213b3/schema)