Skip to content
CCPEDIAby Unity Nodes
Documentation/Canton Network Docs/Splice APIsScan APIsScan APIView on Canton Network Docs

GET /status

GET
/
api
/
scan
/
status
Try it
cURL
Python
JavaScript
PHP
Go
Java
Ruby
curl --request GET \
  --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/status'
import json
import requests

url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/status"
response = requests.request("GET", url)

print(response.text)
const response = await fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/status', {
  method: 'GET',
});

console.log(await response.text());
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://scan.sv-1.global.canton.network.sync.global/api/scan/status',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
]);

$response = curl_exec($curl);
echo $response;
package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://scan.sv-1.global.canton.network.sync.global/api/scan/status", nil)
  response, _ := http.DefaultClient.Do(req)
  defer response.Body.Close()
  body, _ := io.ReadAll(response.Body)
  fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://scan.sv-1.global.canton.network.sync.global/api/scan/status"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'

uri = URI('https://scan.sv-1.global.canton.network.sync.global/api/scan/status')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
  http.request(request)
end
puts response.body
200
{
  "success": {
    "id": "<string>",
    "uptime": "<string>",
    "ports": {},
    "extra": "<string>",
    "active": false
  }
}

Health status

OpenAPI
cURL
Python
JavaScript
PHP
Go
Java
Ruby
curl --request GET \
  --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/status'
import json
import requests

url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/status"
response = requests.request("GET", url)

print(response.text)
const response = await fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/status', {
  method: 'GET',
});

console.log(await response.text());
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://scan.sv-1.global.canton.network.sync.global/api/scan/status',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
]);

$response = curl_exec($curl);
echo $response;
package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://scan.sv-1.global.canton.network.sync.global/api/scan/status", nil)
  response, _ := http.DefaultClient.Do(req)
  defer response.Body.Close()
  body, _ := io.ReadAll(response.Body)
  fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://scan.sv-1.global.canton.network.sync.global/api/scan/status"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'

uri = URI('https://scan.sv-1.global.canton.network.sync.global/api/scan/status')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
  http.request(request)
end
puts response.body
200
{
  "success": {
    "id": "<string>",
    "uptime": "<string>",
    "ports": {},
    "extra": "<string>",
    "active": false
  }
}

Responses

200

ok
application/json
value
NodeStatus
required

Show child attributes

SuccessStatusResponse
SuccessStatusResponse

Show child attributes

success
Status
required

Show child attributes

id
string
required
uptime
string
required
ports
object
required
extra
string (binary)
active
boolean
required
NotInitializedStatusResponse
NotInitializedStatusResponse

Show child attributes

not_initialized
NotInitialized
required

Show child attributes

active
boolean
required
FailureStatusResponse
FailureStatusResponse

Show child attributes

failed
ErrorResponse
required

Show child attributes

error
string
required