Listar Despliegues - Square Cloud

GET

apps

{app_id}

deployments

Listar Despliegues

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

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}/deployments', 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",
  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"

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

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": [
        [
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "pending",
			    "date": "2023-10-16T20:27:20.513Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "clone",
			    "date": "2023-10-16T20:27:20.536Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "success",
			    "date": "2023-10-16T20:27:21.422Z"
		    }
	    ]
    ],
}

string

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Usa este endpoint para inspeccionar qué ocurrió durante los despliegues recientes: cada array interno captura el ciclo de vida de un intento de despliegue, pasando por los estados pending, clone (solo en despliegues basados en Git), commit, restarting y success. Cada evento incluye un campo source derivado: git cuando el despliegue proviene de un webhook o de un push de GitHub App, upload cuando proviene de una subida en zip o de una llamada a Enviar Commit a la Aplicación. El registro de despliegues proviene de una caché de corta duración del clúster, por lo que solo refleja la actividad más reciente de la aplicación y devuelve un array vacío cuando ya no queda nada registrado. Para revisar la integración de Git configurada actualmente, en lugar de intentos de despliegue pasados, consulta Obtener Despliegue Actual.

Parámetros

string

requerido

El ID de la aplicación. Puedes encontrarlo en la URL del panel de tu aplicación.

Respuesta

string

Indica si la llamada fue exitosa. success si fue exitosa, error si no.

array

El contenido de la respuesta.

Mostrar Alternar objeto

string

El ID del deploy.

string

El estado del deploy. Puede ser pending, clone, success o error.

string

La fecha en que se creó el deploy.

{
    "status": "success",
    "response": [
        [
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "pending",
			    "date": "2023-10-16T20:27:20.513Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "clone",
			    "date": "2023-10-16T20:27:20.536Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "success",
			    "date": "2023-10-16T20:27:21.422Z"
		    }
	    ]
    ],
}

Obtener Despliegue ActualObtén la información del despliegue actual de una aplicación.

Listar Despliegues

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

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}/deployments', 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",
  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"

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

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": [
        [
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "pending",
			    "date": "2023-10-16T20:27:20.513Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "clone",
			    "date": "2023-10-16T20:27:20.536Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "success",
			    "date": "2023-10-16T20:27:21.422Z"
		    }
	    ]
    ],
}

​Parámetros

​Respuesta

Parámetros

Respuesta