Obter implantação atual

GET

apps

{app_id}

deployments

current

Obter implantação atual

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/deployments/current")
  .header("Authorization", "<authorization>")
  .asString();

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": "Seu-GitHub/Repositório",
            "branch": "main"
        }
    }
}

Authorization

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Este endpoint informa como a aplicação está configurada atualmente para implantações baseadas em Git: uma vinculação de repositório via GitHub App, uma URL de webhook legada, ou ambas, dependendo de como a integração foi configurada. Use-o para verificar o repositório e a branch rastreados antes de investigar um problema de implantação, ou para confirmar se ainda é necessário gerar um webhook. A resposta é armazenada em cache por 5 minutos por proprietário e aplicação, então alterações feitas através de Configurar webhook do GitHub podem levar alguns minutos para aparecer aqui. Em aplicações compartilhadas em workspace, quem chama precisa da função Gerente ou Administrador, ou ser o proprietário. Para ver o histórico de implantações em vez da configuração atual, use Listar implantações.

Parâmetros

app_id

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL do painel da sua aplicação.

Resposta

status

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

response

object

O conteúdo da resposta.

Mostrar Alternar objeto

webhook

string

A URL do webhook para a aplicação.

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

{
    "status": "success",
    "response": {
        "app": {
            "id": "00000000",
            "name": "Seu-GitHub/Repositório",
            "branch": "main"
        }
    }
}

Configurar webhook do GitHubIntegrar a Square Cloud com webhooks do GitHub.

Obter implantação atual

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/deployments/current")
  .header("Authorization", "<authorization>")
  .asString();

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": "Seu-GitHub/Repositório",
            "branch": "main"
        }
    }
}

​Parâmetros

​Resposta

Parâmetros

Resposta