There is a problem creating a stack that contains a semicolon environment variable using the portainer API.

[Aaron-Bae]

Ask a Question!

JSON

[
{"name": "TZ", "value": "Asia/Seoul"},
{"name": "DB_ADDRESS", "value": "Server=db;Port=5432;User Id=ID;Password=PASSWORD;Database=database;ApplicationName=ui;"}
]

I'm trying to create a stack using the /stacks/create/swarm/file API, but I get the following return.

{"message":"Invalid request payload","details":"Invalid Env parameter"}

How can I include semicolons?

Portainer version : 2.21.5
docker version : 4.37.1

[Nick-Portainer]

Hi @Aaron-Bae You need to make sure your JSON is formatted correctly, you can see an example in our API Docs - https://app.swaggerhub.com/apis/portainer/portainer-ce/2.21.5#/stacks/StackCreateDockerSwarmFile

[Aaron-Bae]

Thank you @Nick-Portainer

I checked the API Docs. There seems to be no problem with the json format , but there is a problem if the value includes ";". I need ";" for the environment variable, is this not possible?

[Aaron-Bae]

I was able to solve the problem. Instead of using "-F" I changed it to "--form-string" so that I can use the semi-colon inside my $ENV_JSON.

Before:
curl -s -X POST curl -s -X POST "$PORTAINER_URL/stacks/create/swarm/file?endpointId=$ENDPOINT_ID"
-H "X-API-Key: $ACCESS_TOKEN"
-H "Content-Type: multipart/form-data"
-F "Name=$STACK_NAME"
-F "SwarmID=$SWARM_ID"
-F "file=@$COMPOSE_FILE"
-F "Env=$ENV_JSON"
-F "Prune=true"

After:
curl -s -X POST "$PORTAINER_URL/stacks/create/swarm/file?endpointId=$ENDPOINT_ID"
-H "X-API-Key: $ACCESS_TOKEN"
-H "Content-Type: multipart/form-data"
-F "Name=$STACK_NAME"
-F "SwarmID=$SWARM_ID"
-F "file=@$COMPOSE_FILE"
--form-string "Env=$ENV_JSON"
-F "Prune=true"