ARNPROXY

Zugriffsumfang prüfen

GET/account/api/v1/proxies/{id}/access

Autorisierung

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Erforderliche Berechtigungproxy_management
Acceptapplication/json

Parameter

NameTypBeschreibung
id
pathErforderlich
integerEigene Datensatz-ID für diesen Vorgang; 1–2147483647. Keine angezeigte Bestellnummer oder Anbieter-ID.

Anfragebeispiel

cURL
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    'https://www.arnproxy.com/account/api/v1/proxies/YOUR_PROXY_ID/access'

Beispiele werden hier nicht ausgeführt. Speichern Sie den API-Schlüssel in einer serverseitigen Umgebungsvariablen, nie in URLs oder Browsercode. Bereiten Sie request.json für POST vor.

Antworten

200Erfolgsantwort
application/json
{
    "ok": true,
    "data": {
        "proxy_id": 12345,
        "proxy_ids": [
            12345
        ],
        "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "verified_at": "2030-01-01T12:00:00+00:00",
        "username": null,
        "authorized_ips": [],
        "credential_rules": {
            "username_min_length": 8,
            "username_max_length": 8,
            "password_min_length": 10,
            "password_max_length": 10,
            "generated_username_length": 8,
            "generated_password_length": 10,
            "characters": "ASCII_ALPHANUMERIC"
        },
        "credential_role": "primary",
        "primary_credentials_managed_by": "admin",
        "credentials_change_available": false,
        "credentials_delete_available": false,
        "credentials_change_requires_new_username": false,
        "credential_management_unavailable_reason": "PRIMARY_CREDENTIAL_ADMIN_ONLY",
        "supplemental_credentials_available": false,
        "authorized_ip_add_available": true,
        "authorized_ip_remove_available": true,
        "authorized_ip_families": [
            4,
            6
        ],
        "ip_management_unavailable_reason": null,
        "group_change_required": true,
        "source": "provider_verified_scope",
        "authorization_scope": "upstream_order",
        "may_affect_other_proxies": false,
        "ip_records_customer_owned": true
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
Antwortfelder und Typen
NameTypBeschreibung
okbooleanErfolgskennzeichen; bei false error.code prüfen.
dataobjectVorgangsspezifisches Ergebnis; Beispiele sind synthetisch und dienen der Veranschaulichung.
data.proxy_idintegerZugehörige ARNPROXY-Datensatz-ID statt interner Anbieter-ID verwenden.
data.proxy_idsarrayProxy-IDs im für dieses Konto sichtbaren Umfang.
data.proxy_ids[]integerProxy-IDs im für dieses Konto sichtbaren Umfang.
data.revisionstringAktualitätskennung unverändert an die zugehörige Änderung/Preisbestätigung zurückgeben.
data.verified_atstringZeitstempel im vom API gelieferten Format; Beispieldaten sind synthetisch.
data.usernamestring|nullSensible Zugangsdaten unter Berechtigungs- und Dienstbedingungen; nie protokollieren oder teilen.
data.authorized_ipsstring[]Vorgangsspezifischer Wert für authorized ips. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credential_rulesobjectVorgangsspezifischer Wert für credential rules. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credential_rules.username_min_lengthintegerVorgangsspezifischer Wert für username min length. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credential_rules.username_max_lengthintegerVorgangsspezifischer Wert für username max length. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credential_rules.password_min_lengthintegerVorgangsspezifischer Wert für password min length. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credential_rules.password_max_lengthintegerVorgangsspezifischer Wert für password max length. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credential_rules.generated_username_lengthintegerVorgangsspezifischer Wert für generated username length. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credential_rules.generated_password_lengthintegerVorgangsspezifischer Wert für generated password length. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credential_rules.charactersstringVorgangsspezifischer Wert für characters. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credential_rolestringVorgangsspezifischer Wert für credential role. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.primary_credentials_managed_bystringVorgangsspezifischer Wert für primary credentials managed by. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credentials_change_availablebooleanVorgangsspezifischer Wert für credentials change available. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credentials_delete_availablebooleanVorgangsspezifischer Wert für credentials delete available. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credentials_change_requires_new_usernamebooleanVorgangsspezifischer Wert für credentials change requires new username. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.credential_management_unavailable_reasonstringVorgangsspezifischer Wert für credential management unavailable reason. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.supplemental_credentials_availablebooleanVorgangsspezifischer Wert für supplemental credentials available. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.authorized_ip_add_availablebooleanVorgangsspezifischer Wert für authorized ip add available. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.authorized_ip_remove_availablebooleanVorgangsspezifischer Wert für authorized ip remove available. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.authorized_ip_familiesarrayVorgangsspezifischer Wert für authorized ip families. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.authorized_ip_families[]integerVorgangsspezifischer Wert für authorized ip families. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.ip_management_unavailable_reasonstring|nullVorgangsspezifischer Wert für ip management unavailable reason. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.group_change_requiredbooleanVorgangsspezifischer Wert für group change required. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.sourcestringDatenquelle; lokale Datensätze und Live-Anbieterabfragen sind unterschiedliche Nachweise.
data.authorization_scopestringAutorisierungsumfang; Bestell-/Paketaktionen können andere Zuordnungen beeinflussen.
data.may_affect_other_proxiesbooleanAndere Zuordnungen können durch den paket-/bestellweiten Umfang betroffen sein.
data.ip_records_customer_ownedbooleanVorgangsspezifischer Wert für ip records customer owned. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
metaobjectMetadaten zu Anfragezuordnung und Datenquelle.
meta.request_idstringKennung dieser HTTP-Anfrage, kein Vorgangsschlüssel oder Bestell-ID.
meta.phasestringVorgangsspezifischer Wert für phase. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
meta.sourcestringDatenquelle; lokale Datensätze und Live-Anbieterabfragen sind unterschiedliche Nachweise.

Fehlerantwort

HTTP 401 · INVALID_API_KEY
{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

Authentifizierung und Validierung können eine Anfrage vor der Ausführung ablehnen. Beachten Sie die Fehlerreferenz und bewahren Sie request_id für den Support auf. Senden Sie niemals Schlüssel oder Passwörter. Fehler & Limits →

Verhalten & wichtige Hinweise

  • Eine Aktion kann die gesamte Berechtigungsgruppe, etwa eine Bestellung oder ein Paket, betreffen, nicht nur den gewählten Proxy. Vorher proxy_ids, authorization_scope und may_affect_other_proxies prüfen. Bei geändertem Umfang eine neue revision abrufen.
  • Die Freigabeliste unter Mein Konto → API legt fest, welche Adressen den API-Schlüssel verwenden dürfen; sie wird auf der Kontoseite verwaltet. Die IP-Freigabe eines Proxys bestimmt dagegen, welche Adressen sich mit dem Proxy verbinden dürfen. Beide Einstellungen sind unabhängig.

Suche in der aktuellen Sprache. Schließen mit Esc