setRemoteReference

form schema

Override one of an instance's connection slots with a resource from another project (or an imported resource).

The instance must not be in PROVISIONED or FAILED status — like other configuration changes, overrides cannot be set on a deployed instance.

The override takes priority over any blueprint-level Link wired into the same slot. Removing the override reverts to the Link (or environment default).

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

setRemoteReference(
  organizationId: ID!
  instanceId: ID!
  resourceId: ID!
  input: SetRemoteReferenceInput!
): RemoteReferencePayload

Form Schema

This mutation supports dynamic form generation using JSON Schema.

• JSON Schema
• UI Schema

Loading schema...

Arguments

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

Your organization's unique identifier.

setRemoteReference.instanceId ● ID! non-null scalar {#instance-id}

The instance to set the remote reference on.

setRemoteReference.resourceId ● ID! non-null scalar {#resource-id}

The resource to reference — either a UUID for imported resources or 'instance.field' for provisioned resources.

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