Upload Sign-in Logo
Set the logo of the endpoint's sign-in pages: the sign-in, sign-up, forgot-password and account pages its users see. It shows above the title and replaces any logo the endpoint had. ngris redraws the picture as a new PNG, at most 512 pixels on a side, so no script or metadata in the file reaches a page.
The endpoint needs sign-in settings first (Update Endpoint Auth Settings). Your own logo is a plan feature (endpoint_branding). Requires the endpoints:update permission in the active account. At most 10 uploads a minute per user.
Path parameters
uuid string (uuid) Req
The endpoint's
uuid from List Endpoints.Request body
multipart/form-data with one file:
file file Req
A PNG, JPG or WebP picture up to 256 KB and 2048 pixels on a side.
Response (200 OK)
The stored logo: the sha256 of the PNG, its size in bytes, and its width and height in pixels. Get Endpoint Settings shows the same object as config.logo.
Errors
400 Bad Request
No file in the form field
file, or a file that isn't a logo; the message says what to change, for example the logo file is larger than 256 KB, the logo must be a PNG, JPG or WebP picture or the logo picture is too large (over 2048 pixels on a side); make it smaller.401 Unauthorized
Missing or invalid auth.
403 Forbidden
Your plan doesn't include your own logo (
entitlement_required: endpoint_branding), your role lacks endpoints:update, or the account is suspended (account_suspended).404 Not Found
endpoint not found — the endpoint belongs to another account.409 Conflict
The endpoint has no sign-in settings yet, or it's paused over your plan's limits (
quota_paused).429 Too Many Requests
More than 10 uploads in a minute.
503 Service Unavailable
Logos are busy being processed; try again after
Retry-After seconds.Request
curl -X PUT "https://api.ngris.com/v1/endpoints/019ba0a5-abcc-7a95-af8e-2f8559f823cd/settings/logo" \
-H "X-API-KEY: <your_api_key>" \
-F "file=@logo.png"
CLI
ngris api endpoints set-sign-in-logo 019ba0a5-abcc-7a95-af8e-2f8559f823cd --file logo.png
Response
{
"logo": {
"sha256": "9f2c4e0b7d1a3c5e8f6b2d4a0c1e3f5a7b9d2c4e6f8a0b1c3d5e7f9a1b3c5d7e",
"size": 18342,
"width": 512,
"height": 128
}
}
Was this helpful?