Add Application - Square Cloud

POST

workspaces

applications

Add Application

curl --request POST \
  --url https://api.squarecloud.app/v2/workspaces/applications \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "appId": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/workspaces/applications"

payload = {
    "workspaceId": "<string>",
    "appId": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workspaceId: '<string>', appId: '<string>'})
};

fetch('https://api.squarecloud.app/v2/workspaces/applications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces/applications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workspaceId' => '<string>',
    'appId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/workspaces/applications"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"appId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/workspaces/applications")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"appId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces/applications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"appId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success"
}

Authorization

string

required

The API key for your account. You can find this in your account settings.

Shares an application owned by the authenticated user into a workspace they also own, giving the workspace’s members access to it according to their role instead of transferring ownership. A workspace holds up to 100 shared applications, and the same application cannot be shared into the same workspace twice. This is a workspace-owner-only action: the caller must own both the workspace and the application. Use Get Application Info beforehand to confirm the application ID, and Remove Application to undo the share later. Rate limited to 10 additions per 30 seconds per user.

Parameters

workspaceId

string

The ID of the workspace.

appId

string

The ID of the application. You can find this in the URL of your application’s dashboard.

Response

status

string

Indicates whether the call was successful.. success if successful, error if not.

{
  "status": "success"
}

Common errors

Code	HTTP	Meaning
`INVALID_ID`	400	`workspaceId` is missing.
`APP_NOT_FOUND`	400	`appId` is missing from the request body.
`APP_NOT_FOUND`	404	No application with that ID exists for the caller.
`WORKSPACE_NOT_FOUND`	404	The workspace does not exist or is not owned by the caller.
`APPLICATIONS_LIMIT_REACHED`	400	The workspace already has 100 shared applications.
`APP_ALREADY_IN_WORKSPACE`	400	The application is already shared into this workspace.

Remove ApplicationRemove an application from the workspace.

Add Application

curl --request POST \
  --url https://api.squarecloud.app/v2/workspaces/applications \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "appId": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/workspaces/applications"

payload = {
    "workspaceId": "<string>",
    "appId": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workspaceId: '<string>', appId: '<string>'})
};

fetch('https://api.squarecloud.app/v2/workspaces/applications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces/applications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workspaceId' => '<string>',
    'appId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/workspaces/applications"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"appId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/workspaces/applications")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"appId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces/applications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"appId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success"
}

​Parameters

​Response

​Common errors

Parameters

Response

Common errors