Obtener dominio - Hybridbox

GET

public

accounts

{account_id}

domains

{domain}

Obtener dominio

curl --request GET \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}', 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.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}",
  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: Bearer <token>"
  ],
]);

$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.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}")

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "outbound_routing_ready": true,
  "status": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "auto_renew": false,
  "created_at": "<string>",
  "dedicated_ip_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dns_records": [
    {
      "id": 123,
      "name": "<string>",
      "ttl": 123,
      "type": "<string>",
      "value": "<string>",
      "is_system_managed": false,
      "priority": 123
    }
  ],
  "inbound_tenant_external_id": "<string>",
  "inbound_tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inbound_tenant_name": "<string>",
  "inbound_tenant_type": "<string>",
  "mailboxes": [
    {
      "active": true,
      "email": "<string>",
      "first_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_name": "<string>"
    }
  ],
  "redirect_mode": "301",
  "redirect_url": "<string>",
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "updated_at": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Autorizaciones

Authorization

string

header

requerido

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

Parámetros de ruta

account_id

string<uuid>

requerido

domain

string

requerido

Respuesta

string<uuid>

requerido

Dominio UUID

name

string

requerido

Nombre de dominio

outbound_routing_ready

boolean

requerido

Si la ruta de salida está lista

status

string

requerido

Estado del ciclo de vida del dominio

workspace_id

string<uuid>

requerido

Espacio de trabajo UUID que contiene el dominio

auto_renew

boolean

predeterminado:false

Si la renovación automática del dominio está habilitada

created_at

string | null

Marca de tiempo de creación del dominio

dedicated_ip_id

string<uuid> | null

IP UUID dedicado asignado, si lo hubiera

dns_records

DomainDnsRecordResponse · object[]

Registros DNS para el dominio.

Hide child attributes

dns_records.id

integer

requerido

Identificador de registro DNS

dns_records.name

string

requerido

Nombre del registro DNS

dns_records.ttl

integer

requerido

DNS registra TTL en segundos

dns_records.type

string

requerido

Tipo de registro DNS

dns_records.value

string

requerido

Valor de registro DNS

dns_records.is_system_managed

boolean

predeterminado:false

Si el registro es administrado por HybridBox

dns_records.priority

integer | null

Prioridad de registro DNS cuando corresponda

inbound_tenant_external_id

string | null

ID externo del proveedor para el inquilino entrante

inbound_tenant_id

string<uuid> | null

Inquilino entrante UUID, si está asignado

inbound_tenant_name

string | null

Nombre para mostrar del inquilino entrante, si está asignado

inbound_tenant_type

string | null

Tipo de inquilino entrante, si está asignado

mailboxes

DomainMailboxSummary · object[]

Buzones de correo en el dominio

Hide child attributes

mailboxes.active

boolean

requerido

Si el buzón está activo

mailboxes.email

string

requerido

Dirección de correo electrónico del buzón principal

mailboxes.first_name

string

requerido

Nombre del usuario del buzón

mailboxes.id

string<uuid>

requerido

Buzón UUID

mailboxes.last_name

string

requerido

Apellido del usuario del buzón

redirect_mode

enum<string> | null

Modo de redirección configurado, si lo hubiera

Opciones disponibles:

301,

302,

iframe

redirect_url

string | null

URL de redireccionamiento configurada, si la hubiera

tags

DomainTagResponse · object[]

Etiquetas adjuntas al dominio

Hide child attributes

tags.id

string<uuid>

requerido

Etiqueta UUID

tags.name

string

requerido

Nombre para mostrar de la etiqueta

updated_at

string | null

Marca de tiempo de la última actualización del dominio

Obtener dominio

curl --request GET \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}', 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.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}",
  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: Bearer <token>"
  ],
]);

$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.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}")

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "outbound_routing_ready": true,
  "status": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "auto_renew": false,
  "created_at": "<string>",
  "dedicated_ip_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dns_records": [
    {
      "id": 123,
      "name": "<string>",
      "ttl": 123,
      "type": "<string>",
      "value": "<string>",
      "is_system_managed": false,
      "priority": 123
    }
  ],
  "inbound_tenant_external_id": "<string>",
  "inbound_tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inbound_tenant_name": "<string>",
  "inbound_tenant_type": "<string>",
  "mailboxes": [
    {
      "active": true,
      "email": "<string>",
      "first_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_name": "<string>"
    }
  ],
  "redirect_mode": "301",
  "redirect_url": "<string>",
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "updated_at": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}