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 ಅನ್ನು ತೆಗೆದುಕೊಳ್ಳುತ್ತದೆ.
ನಿಮ್ಮ ಸಂಸ್ಥೆಯ ಐಡಿಯು ನಿಮ್ಮ ಡ್ಯಾಶ್ಬೋರ್ಡ್ನಲ್ಲಿರುವ API ಕೀಗಳ ಪರದೆಯ ಮೇಲೆ, ಕೀ ಯ ಪಕ್ಕದಲ್ಲೇ ಇರುತ್ತದೆ. ನೀವು ಮಾಡುವ ಪ್ರತಿಯೊಂದು ಕರೆ(call)ಯಲ್ಲೂ ಇದು ಒಂದೇ ಐಡಿ ಆಗಿರುತ್ತದೆ.
ಪ್ರಯತ್ನಿಸಿ
ಕೋನೀಯ ಬ್ರಾಕೆಟ್ಗಳಲ್ಲಿರುವ ಯಾವುದೇ ಅಂಶವನ್ನು ನಿಮ್ಮ ಸ್ವಂತ ಮೌಲ್ಯಗಳೊಂದಿಗೆ ಮತ್ತು ಕೀ ಪ್ಲೇಸ್ಹೋಲ್ಡರ್ ಅನ್ನು ನಿಮ್ಮ ಡ್ಯಾಶ್ಬೋರ್ಡ್ನಲ್ಲಿರುವ ಕೀಯೊಂದಿಗೆ ಬದಲಾಯಿಸಿ.
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