Api Key

This page is auto-generated from the formations OpenAPI spec. Do not edit manually — run pnpm generate-formations-resource-docs to regenerate.

Creates an API key scoped to the formation's project and optionally restricted by a set of policies. The key is owned by the project owner.

Syntax

type: api_key
properties:
  name: String
  policy_ids: String[]

Output

The physical resource ID is the public ID of the created resource. Reference it from other resources with a ref expression:

      some_field:
        ref: MyApiKey

Properties

name

Human-readable label for the API key

Required: Yes Type: String

---

policy_ids

Optional list of policy public IDs that further restrict the key's permissions

Required: No Type: Array of String

---