resources.configureSource

POST

/resources/{resourceId}/source

curl --request POST \
  --url https://example.com/api/resources/example/source \
  --header 'Content-Type: application/json' \
  --data '{ "source": { "kind": "local-folder", "locator": "./apps/web", "displayName": "Web console", "baseDirectory": ".", "metadata": { "framework": "sveltekit" } }, "idempotencyKey": "configure-source-res-web-console" }'

Configures the source profile used by later deployment detect and plan stages. Public docs: /docs/resources/profiles/source-runtime/#resource-source-profile

Parameters

Path Parameters

resourceId

required

string

>= 1 characters

Request Body ^required

Media type application/json

object

source

required

object

kind

required

string

Allowed values: local-folder local-git remote-git git-public git-github-app git-deploy-key zip-artifact dockerfile-inline docker-compose-inline docker-image compose

locator

required

string

>= 1 characters

displayName

string

>= 1 characters

gitRef

string

>= 1 characters

commitSha

string

>= 1 characters

baseDirectory

string

>= 1 characters

originalLocator

string

>= 1 characters

repositoryId

string

>= 1 characters

repositoryFullName

string

>= 1 characters

defaultBranch

string

>= 1 characters

imageName

string

>= 1 characters

imageTag

string

>= 1 characters

imageDigest

string

>= 1 characters

metadata

object

key

additional properties

string

idempotencyKey

string

>= 1 characters

Examples

Example default

{
  "source": {
    "kind": "local-folder",
    "locator": "./apps/web",
    "displayName": "Web console",
    "baseDirectory": ".",
    "metadata": {
      "framework": "sveltekit"
    }
  },
  "idempotencyKey": "configure-source-res-web-console"
}

Responses

200

OK

Media type application/json

object

id

required

string

Example ^generated

{
  "id": "example"
}