This API v3 documentation is currently still on progress. For any issue, please contact support@runcloud.io

RunCloud

Add new symlink (config)

POST

/atomic/{{atomicProjectId}}/symlinks

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

type

string

required

type of symlink, either 'config' or 'directory'

linkFrom

string

required

Link From (Relative to the configs directory)

linkTo

string

required

Link To (Relative to the live directory)

secretKey

string

optional

Secret key to read the symlink file, only required when type is 'config'

content

string

optional

Content of the file config, only required when type is 'config'

webApplications

array[integer]

optional

IDs of web application that use this symlink, only required when type is 'config'

Example

{
  "type": "config",
  "linkFrom": ".env",
  "linkTo": ".env",
  "secretKey": 123456,
  "content": "hello world",
  "webApplications": [
    582
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://manage.runcloud.io/api/v3/atomic/{{atomicProjectId}}/symlinks' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type":"config",
    "linkFrom":".env",
    "linkTo":".env",
    "secretKey":123456,
    "content":"hello world",
    "webApplications":[
        582
    ]
}'

Responses

🟢200Success

application/json

Body

message

string

required

Example

{
  "message": "A new symlink has been successfully added. The config will be sync in a few moments"
}

Modified at 2024-10-16 09:05:51

List symlinks in atomic project

Add new symlink (directory)