Skip to content
On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / updatePolicy

Function: updatePolicy() ​

updatePolicy<Schema, TQuery>(key, item, query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, Object, "directus_policies" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, Object, "directus_policies" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>, FieldsWildcard<UnpackList<IfAny<Schema, Object, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>

Update an existing policy.

Type parameters ​

• Schema

• TQuery extends Query<Schema, DirectusPolicy<Schema>>

Parameters ​

• key: DirectusPolicy<Schema>["id"]

• item: Partial<DirectusPolicy<Schema>>

• query?: TQuery

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, Object, "directus_policies" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, Object, "directus_policies" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>, FieldsWildcard<UnpackList<IfAny<Schema, Object, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>

Returns the policy object for the updated policy.

Throws ​

Will throw if key is empty

Source ​

rest/commands/update/policies.ts:64