hosting
POST /v1/offsite-destinations
Add a place to send backups to, after proving we can write, read and delete there.
ప్రమాణీకరణ
బీయర్ టోకెన్గా API కీని పంపండి. కీ తప్పనిసరిగా hosting.backup.manage అనుమతిని కలిగి ఉండాలి; అది లేని కీని 404 కాకుండా 403తో తిరస్కరిస్తారు.
మీ సంస్థ ఐడీ ఎక్కడ ఉందో అక్కడ
ఈ ఎండ్పాయింట్ JSON బాడీలో ఫీల్డ్గా org_id ని తీసుకుంటుంది.
మీ సంస్థ ఐడి (organisation id) మీ డాష్బోర్డ్లోని API కీస్ స్క్రీన్పై, కీ పక్కనే ఉంటుంది. మీరు చేసే ప్రతి కాల్లోనూ ఇదే ఐడి ఉపయోగించబడుతుంది.
ప్రయత్నించండి
కోణీయ బ్రాకెట్లలో ఉన్న దేన్నైనా మీ స్వంత విలువలతో భర్తీ చేయండి, మరియు కీ ప్లేస్హోల్డర్ను మీ డాష్బోర్డ్ నుండి తీసుకున్న కీతో భర్తీ చేయండి.
curl -X POST https://api.zinndigital.com/v1/offsite-destinations \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "kind": <string<s3, sftp>> }'సైన్ ఇన్ చేశారా? మీ డ్యాష్బోర్డ్లోని API కాన్సోల్ మీ అసలైన సంస్థ ID మరియు మీ స్వంత కీని నింపుతుంది, అలాగే మీరు అసలైన ప్రతిస్పందనను చూడటానికి లైవ్ API ద్వారా ఆభ్యర్థనను రన్ చేస్తుంది. ఈ ఎండ్పాయింట్ను API కన్సోల్లో తెరిచండి
వివరాలు
The destination is saved only after a real round trip: a small test file is written, read back byte for byte and deleted. For SFTP the server's host key is read without authenticating and pinned; every later connection must present it. Addresses must be on the public internet and S3 endpoints must be https://. Credentials are write-only and go straight to our secret store with a fresh encryption key; every archive is encrypted (AES-256-CTR with HMAC-SHA256) before it leaves us. Refusals are 422 with a machine code in details[0].code. Requires hosting.backup.manage.
అభ్యర్థన బాడీ
| పేరు | రకం | కావలసినది | ఇది ఏమిటి |
|---|---|---|---|
org_id | string | కాదు | — |
name | string | అవును | — |
kind | string<s3, sftp> | అవును | — |
prefix | string | కాదు | — |
endpoint | string | కాదు | S3: an https:// endpoint with no path. |
region | string | కాదు | S3: the bucket's region, or auto for Cloudflare R2. |
bucket | string | కాదు | — |
access_key_id | string | కాదు | — |
secret_access_key | string | కాదు | — |
host | string | కాదు | SFTP: the server's host name. |
port | integer | కాదు | — |
username | string | కాదు | — |
password | string | కాదు | — |
private_key | string | కాదు | OpenSSH format. |
స్పందన
| పేరు | రకం | కావలసినది | ఇది ఏమిటి |
|---|---|---|---|
id | string | అవును | — |
org_id | string | అవును | — |
name | string | అవును | — |
kind | string<s3, sftp> | అవును | — |
endpoint | string | కాదు | — |
region | string | కాదు | — |
bucket | string | కాదు | — |
host | string | కాదు | — |
port | integer | కాదు | — |
username | string | కాదు | — |
host_key_fingerprint | string | కాదు | The pinned SFTP host key as SHA256:…, the form ssh-keygen -lf prints. |
prefix | string | అవును | — |
status | string<working, failing> | అవును | — |
last_checked_at | string | కాదు | — |
last_check_code | string | కాదు | — |
sites_using | integer | అవును | — |
created_at | string | అవును | — |
ఈ ఎండ్పాయింట్ తిరిగి ఇవ్వగల లోపాలు
401 · 403 · 404 · 422