Skip to main content

setRemoteReference

form schema

Set a remote reference on an instance, linking one of its resource fields to an external resource.

The target resource can be from another project or an imported resource. The instance must not be in PROVISIONED or FAILED status — you can only set remote references on instances that haven't been deployed yet or have been decommissioned.

If this is the first remote reference on the instance, the instance status transitions to EXTERNAL.

mutation {
  setRemoteReference(
    organizationId: "my-org"
    input: {
      instanceId: "my-app"
      field: "aws_authentication"
      resourceId: "shared-creds-abc123"
    }
  ) {
    result { id field resource { id name } }
    successful
    messages { field message }
  }
}
setRemoteReference(
  organizationId: ID!
  input: SetRemoteReferenceInput!
): RemoteReferencePayload

Form Schema​

This mutation supports dynamic form generation using JSON Schema.

Loading schema...

Arguments​

setRemoteReference.organizationId ● ID! non-null scalar {#organization-id}​

Your organization's unique identifier.

setRemoteReference.input ● SetRemoteReferenceInput! non-null input {#input}​

Link an instance's resource field to a resource from another project or an imported resource. The instance must not be in a provisioned or failed state.

Type​

RemoteReferencePayload object​