> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# actions

# `prefect.server.schemas.actions`

Reduced schemas for accepting API actions.

## Functions

### `validate_base_job_template` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L884](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L884)</sup>

```python theme={null}
validate_base_job_template(v: dict[str, Any]) -> dict[str, Any]
```

## Classes

### `ActionBaseModel` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L63](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L63)</sup>

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```python theme={null}
reset_fields(self: Self) -> Self
```

Reset the fields of the model that are in the `_reset_fields` set.

**Returns:**

* A new instance of the model with the reset fields.

### `FlowCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L67](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L67)</sup>

Data used by the Prefect REST API to create a flow.

### `FlowUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L85)</sup>

Data used by the Prefect REST API to update a flow.

### `DeploymentScheduleCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L110](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L110)</sup>

**Methods:**

#### `validate_max_scheduled_runs` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L135](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L135)</sup>

```python theme={null}
validate_max_scheduled_runs(cls, v: PositiveInteger | None) -> PositiveInteger | None
```

### `DeploymentScheduleUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L143](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L143)</sup>

**Methods:**

#### `validate_max_scheduled_runs` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L169](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L169)</sup>

```python theme={null}
validate_max_scheduled_runs(cls, v: PositiveInteger | None) -> PositiveInteger | None
```

### `DeploymentCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L177](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L177)</sup>

Data used by the Prefect REST API to create a deployment.

**Methods:**

#### `check_valid_configuration` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L255](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L255)</sup>

```python theme={null}
check_valid_configuration(self, base_job_template: dict[str, Any]) -> None
```

Check that the combination of base\_job\_template defaults and job\_variables
conforms to the specified schema.

NOTE: This method does not hydrate block references in default values within the
base job template to validate them. Failing to do this can cause user-facing
errors. Instead of this method, use `validate_job_variables_for_deployment`
function from `prefect_cloud.orion.api.validation`.

#### `remove_old_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L281](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L281)</sup>

```python theme={null}
remove_old_fields(cls, values: dict[str, Any]) -> dict[str, Any]
```

### `DeploymentUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L310](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L310)</sup>

Data used by the Prefect REST API to update a deployment.

**Methods:**

#### `check_valid_configuration` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L377](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L377)</sup>

```python theme={null}
check_valid_configuration(self, base_job_template: dict[str, Any]) -> None
```

Check that the combination of base\_job\_template defaults and job\_variables
conforms to the schema specified in the base\_job\_template.

NOTE: This method does not hydrate block references in default values within the
base job template to validate them. Failing to do this can cause user-facing
errors. Instead of this method, use `validate_job_variables_for_deployment`
function from `prefect_cloud.orion.api.validation`.

#### `remove_old_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L315](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L315)</sup>

```python theme={null}
remove_old_fields(cls, values: dict[str, Any]) -> dict[str, Any]
```

### `FlowRunUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L416](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L416)</sup>

Data used by the Prefect REST API to update a flow run.

**Methods:**

#### `set_name` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L431](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L431)</sup>

```python theme={null}
set_name(cls, name: str) -> str
```

### `StateCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L435](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L435)</sup>

Data used by the Prefect REST API to create a new state.

**Methods:**

#### `default_name_from_type` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L456](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L456)</sup>

```python theme={null}
default_name_from_type(self)
```

If a name is not provided, use the type

#### `default_scheduled_start_time` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L466](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L466)</sup>

```python theme={null}
default_scheduled_start_time(self)
```

### `TaskRunCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L476](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L476)</sup>

Data used by the Prefect REST API to create a task run

**Methods:**

#### `set_name` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L548](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L548)</sup>

```python theme={null}
set_name(cls, name: str) -> str
```

#### `validate_cache_key` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L553](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L553)</sup>

```python theme={null}
validate_cache_key(cls, cache_key: str | None) -> str | None
```

### `TaskRunUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L557](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L557)</sup>

Data used by the Prefect REST API to update a task run

**Methods:**

#### `set_name` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L566](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L566)</sup>

```python theme={null}
set_name(cls, name: str) -> str
```

### `FlowRunCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L570](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L570)</sup>

Data used by the Prefect REST API to create a flow run.

**Methods:**

#### `set_name` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L645](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L645)</sup>

```python theme={null}
set_name(cls, name: str) -> str
```

### `DeploymentFlowRunCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L649](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L649)</sup>

Data used by the Prefect REST API to create a flow run from a deployment.

**Methods:**

#### `set_name` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L704](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L704)</sup>

```python theme={null}
set_name(cls, name: str) -> str
```

### `SavedSearchCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L708](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L708)</sup>

Data used by the Prefect REST API to create a saved search.

### `ConcurrencyLimitCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L717](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L717)</sup>

Data used by the Prefect REST API to create a concurrency limit.

### `ConcurrencyLimitV2Create` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L726](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L726)</sup>

Data used by the Prefect REST API to create a v2 concurrency limit.

### `ConcurrencyLimitV2Update` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L746](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L746)</sup>

Data used by the Prefect REST API to update a v2 concurrency limit.

### `BlockTypeCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L757](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L757)</sup>

Data used by the Prefect REST API to create a block type.

### `BlockTypeUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L778](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L778)</sup>

Data used by the Prefect REST API to update a block type.

**Methods:**

#### `updatable_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L787](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L787)</sup>

```python theme={null}
updatable_fields(cls) -> set[str]
```

### `BlockSchemaCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L791](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L791)</sup>

Data used by the Prefect REST API to create a block schema.

### `BlockDocumentCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L809](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L809)</sup>

Data used by the Prefect REST API to create a block document.

**Methods:**

#### `validate_name_is_present_if_not_anonymous` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L834](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L834)</sup>

```python theme={null}
validate_name_is_present_if_not_anonymous(cls, values: dict[str, Any]) -> dict[str, Any]
```

### `BlockDocumentUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L840](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L840)</sup>

Data used by the Prefect REST API to update a block document.

### `BlockDocumentReferenceCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L852](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L852)</sup>

Data used to create block document reference.

**Methods:**

#### `validate_parent_and_ref_are_different` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L869](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L869)</sup>

```python theme={null}
validate_parent_and_ref_are_different(cls, values)
```

### `LogCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L873](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L873)</sup>

Data used by the Prefect REST API to create a log.

### `WorkPoolCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L915](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L915)</sup>

Data used by the Prefect REST API to create a work pool.

### `WorkPoolUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L944](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L944)</sup>

Data used by the Prefect REST API to update a work pool.

### `WorkQueueCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L960](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L960)</sup>

Data used by the Prefect REST API to create a work queue.

### `WorkQueueUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L989](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L989)</sup>

Data used by the Prefect REST API to update a work queue.

### `ArtifactCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1010](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1010)</sup>

Data used by the Prefect REST API to create an artifact.

**Methods:**

#### `from_result` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1050](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1050)</sup>

```python theme={null}
from_result(cls, data: Any | dict[str, Any]) -> 'ArtifactCreate'
```

### `ArtifactUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1068](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1068)</sup>

Data used by the Prefect REST API to update an artifact.

### `VariableCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1078](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1078)</sup>

Data used by the Prefect REST API to create a Variable.

### `VariableUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1094](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1094)</sup>

Data used by the Prefect REST API to update a Variable.