Aktuelles Deployment abrufen

GET

apps

{app_id}

deployments

current

Aktuelles Deployment abrufen

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/deployments/current \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/deployments/current"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/deployments/current', 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/apps/{app_id}/deployments/current",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/deployments/current"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deployments/current")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

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

{
    "status": "success",
    "response": {
        "webhook": "https://api.squarecloud.app/v2/git/webhook/69ce71f11974f2cc21d47cd0a8bcbafdaacbc3c9924b23ca40e0e2032705f6391eb89b40983338e0f2415e9331d602ccc"
    }
}

{
    "status": "success",
    "response": {
        "app": {
            "id": "00000000",
            "name": "Your-GitHub/Repository",
            "branch": "main"
        }
    }
}

string

erforderlich

Der API-Schlüssel für Ihr Konto. Sie finden ihn in Ihren Kontoeinstellungen.

Dieser Endpunkt zeigt, wie die Anwendung aktuell für Git-basierte Deployments verknüpft ist: eine GitHub-App-Repository-Verknüpfung, eine klassische Webhook-URL oder beides, je nachdem, wie die Integration eingerichtet wurde. Nutze ihn, um das verfolgte Repository und den Branch zu prüfen, bevor du ein Deployment-Problem untersuchst, oder um zu bestätigen, ob noch ein Webhook erzeugt werden muss. Die Antwort wird 5 Minuten lang pro Besitzer und Anwendung zwischengespeichert, daher können Änderungen über GitHub-Webhook einrichten einige Minuten brauchen, bis sie hier sichtbar werden. Bei Workspace-geteilten Anwendungen benötigt der Aufrufer die Rolle Manager oder Administrator, oder muss Eigentümer sein. Um den Deployment-Verlauf statt der aktuellen Konfiguration zu sehen, nutze Deployments auflisten.

Parameter

string

erforderlich

Die ID der Anwendung. Du findest sie in der URL des Dashboards deiner Anwendung.

Antwort

string

Gibt an, ob der Aufruf erfolgreich war. success bei Erfolg, error andernfalls.

object

Der Inhalt der Antwort.

Anzeigen Objekt umschalten

string

Die Webhook-URL der Anwendung.

{
    "status": "success",
    "response": {
        "webhook": "https://api.squarecloud.app/v2/git/webhook/69ce71f11974f2cc21d47cd0a8bcbafdaacbc3c9924b23ca40e0e2032705f6391eb89b40983338e0f2415e9331d602ccc"
    }
}

{
    "status": "success",
    "response": {
        "app": {
            "id": "00000000",
            "name": "Your-GitHub/Repository",
            "branch": "main"
        }
    }
}

Zurück

GitHub-Webhook einrichtenIntegrieren Sie Square Cloud mit GitHub-Webhooks.

Weiter

Aktuelles Deployment abrufen

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/deployments/current \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/deployments/current"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/deployments/current', 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/apps/{app_id}/deployments/current",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/deployments/current"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deployments/current")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

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

{
    "status": "success",
    "response": {
        "webhook": "https://api.squarecloud.app/v2/git/webhook/69ce71f11974f2cc21d47cd0a8bcbafdaacbc3c9924b23ca40e0e2032705f6391eb89b40983338e0f2415e9331d602ccc"
    }
}

{
    "status": "success",
    "response": {
        "app": {
            "id": "00000000",
            "name": "Your-GitHub/Repository",
            "branch": "main"
        }
    }
}

​Parameter

​Antwort

Parameter

Antwort