# Key-Values

> Key-Values

This Markdown file sits beside the HTML page at the same path (with a `.md` suffix). It summarizes the topic and lists links for tools and LLM context.

Companion generated at `2026-05-06T18:17:09.838453+00:00` (UTC).

## Primary page

- [Key-Values](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html): Full documentation for this topic (HTML).

## Sections on this page

- [classdatarobot.models.key_values.KeyValue](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.models.key_values.KeyValue): In-page section heading.
- [classmethodget(key_value_id)](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.models.key_values.KeyValue.get): In-page section heading.
- [classmethodlist(entity_id, entity_type)](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.models.key_values.KeyValue.list): In-page section heading.
- [classmethodfind(entity_id, entity_type, name)](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.models.key_values.KeyValue.find): In-page section heading.
- [classmethodcreate(entity_id, entity_type, name, category, value_type, value=None, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.models.key_values.KeyValue.create): In-page section heading.
- [update(entity_id=None, entity_type=None, name=None, category=None, value_type=None, value=None, description=None, comment=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.models.key_values.KeyValue.update): In-page section heading.
- [refresh()](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.models.key_values.KeyValue.refresh): In-page section heading.
- [delete()](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.models.key_values.KeyValue.delete): In-page section heading.
- [get_value()](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.models.key_values.KeyValue.get_value): In-page section heading.
- [classdatarobot.enums.KeyValueCategory](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.enums.KeyValueCategory): In-page section heading.
- [classdatarobot.enums.KeyValueEntityType](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.enums.KeyValueEntityType): In-page section heading.
- [classdatarobot.enums.KeyValueType](https://docs.datarobot.com/en/docs/api/reference/sdk/key_values.html#datarobot.enums.KeyValueType): In-page section heading.

## Related documentation

- [Developer documentation](https://docs.datarobot.com/en/docs/api/index.html): Linked from this page.
- [API reference](https://docs.datarobot.com/en/docs/api/reference/index.html): Linked from this page.
- [datarobot.errors.ClientError](https://docs.datarobot.com/en/docs/api/reference/sdk/errors.html#datarobot.errors.ClientError): Linked from this page.

## Documentation content

### class datarobot.models.key_values.KeyValue

A DataRobot Key-Value.

Added in version v3.4.

- Variables:

#### classmethod get(key_value_id)

Get Key-Value by id.

Added in version v3.4.

- Parameters: key_value_id ( str ) – ID of the Key-Value
- Returns: retrieved Key-Value
- Return type: KeyValue
- Raises:

#### classmethod list(entity_id, entity_type)

List Key-Values.

Added in version v3.4.

- Parameters:
- Returns: a list of Key-Values
- Return type: List[KeyValue]
- Raises:

#### classmethod find(entity_id, entity_type, name)

Find Key-Value by name.

Added in version v3.4.

- Parameters:
- Returns: a list of Key-Values
- Return type: List[KeyValue]
- Raises:

#### classmethod create(entity_id, entity_type, name, category, value_type, value=None, description=None)

Create a Key-Value.

Added in version v3.4.

- Parameters:
- Returns: created Key-Value
- Return type: KeyValue
- Raises:

#### update(entity_id=None, entity_type=None, name=None, category=None, value_type=None, value=None, description=None, comment=None)

Update Key-Value.

Added in version v3.4.

- Parameters:
- Raises:
- Return type: None

#### refresh()

Update Key-Value with the latest data from server.

Added in version v3.4.

- Raises:
- Return type: None

#### delete()

Delete Key-Value.

Added in version v3.4.

- Raises:
- Return type: None

#### get_value()

Get a value of Key-Value.

Added in version v3.4.

- Returns: value depending on the value type
- Return type: Union[str , float , boolean]

### class datarobot.enums.KeyValueCategory

Key-Value category

### class datarobot.enums.KeyValueEntityType

Key-Value entity type

### class datarobot.enums.KeyValueType

Key-Value type