Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
ResourceDefinitionVersion

Get a Resource Definition Version.

get/orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}

Path parameters

orgIdstring required

The Organization ID

defIdstring required

The Resource Definition ID.

defVersionIdstring required

The Resource Definition Version ID.

Response

The Resource Definition Version with the specified ID.

idstring required

The Resource Definition Version ID.

org_idstring required

The Organization ID.

def_idstring required

The Resource Definition ID.

namestring required

The display name.

typestring required

The Resource Type.

driver_typestring required

The driver to be used to create the resource.

driver_accountstring required

(Optional) Security account required by the driver.

in_place_driver_changeboolean required

If true, the Operator will not delete resources provisioned by the previous driver when driver_type changes on a later update; the new driver takes over the existing infrastructure in place. Applies to the Operator provisioning path only.

provisionobject required

(Optional) A map where the keys are resType#resId (if resId is omitted, the same id of the current resource definition is used) of the resources that should be provisioned when the current resource is provisioned. This also specifies if the resources have a dependency on the current resource.

actionstring required

The action that generated the Resource Definition Version. Might be one of created, updated or deleted.

archivedboolean required

Specifies if the version is archived (i.e. can't be used for a new resource).

activeboolean required

Specifies if the version is active (i.e. is being used if target version is not specified for a resource or a context).

proposedboolean required

Specifies if the version is proposed (i.e. is newer than the active version).

created_atstring date-time required

The timestamp of when this record has been created.

created_bystring required

The user who created this record.

Example response

{
  "id": "01234567-89ab-cdef-0123-4567890abcdef",
  "org_id": "test-org",
  "def_id": "dev-postgres",
  "name": "Dev Postgres Instance",
  "type": "postgres",
  "driver_type": "humanitec/postgres-cloudsql",
  "driver_account": "gcp-dev-cloudsql",
  "driver_inputs": {
    "secret_refs": {
      "credentials": {
        "password": {
          "value": "<secret>"
        },
        "user": {
          "ref": "vault/path/to/data/secrets/user",
          "store": "my-external-vault",
          "version": "1"
        }
      }
    },
    "values": {
      "instance": "my-dev-project:my-region:dev-db"
    }
  },
  "provision": {
    "aws-policy": {
      "is_dependent": false,
      "match_dependents": false
    },
    "dns#my-dns": {}
  },
  "created_at": "2020-05-23T12:32:16Z",
  "created_by": "a.user@example.com",
  "action": "created",
  "archived": false,
  "active": true,
  "proposed": false
}