https://nexmo.github.io/api-standards/http-code/Recent content in Http-codes on My New Hugo SiteHugo -- gohugo.ioen-usMon, 14 Dec 2020 19:02:33 +0000https://nexmo.github.io/api-standards/http-code/422/Mon, 14 Dec 2020 19:02:33 +0000https://nexmo.github.io/api-standards/http-code/422/ 422 Validation error, used when the request does not meet existing validation rules. More details should be available (specific error, and human description) in the response body. Example response { "type": "https://developer.nexmo.com/api-errors/account/secret-management#validation", "title": "Bad Request", "detail": "The request failed due to validation errors", "invalid_parameters": [ { "name": "secret", "reason": "must contain 1 upper case character" } ], "instance": "797a8f199c45014ab7b08bfe9cc1c12c" }https://nexmo.github.io/api-standards/http-code/415/Tue, 31 Jul 2018 02:43:59 +0100https://nexmo.github.io/api-standards/http-code/415/ 415 The 415 HTTP code is used when an unsupported Content-Type header is supplied Example response { "type": "https://developer.nexmo.com/api-errors#content-type-header", "title": "Invalid Content-Type header", "detail": "Invalid Content-Type header provided. Must be one of the following: 'application/json'", "instance": "797a8f199c45014ab7b08bfe9cc1c12c" }https://nexmo.github.io/api-standards/http-code/406/Tue, 31 Jul 2018 02:43:56 +0100https://nexmo.github.io/api-standards/http-code/406/ 406 The 406 HTTP code is used when an unsupported Accept header is supplied Example response { "type": "https://developer.nexmo.com/api-errors#accept-header", "title": "Invalid Accept header", "detail": "Invalid Accept header provided. Must be one of the following: 'application/json'", "instance": "797a8f199c45014ab7b08bfe9cc1c12c" }https://nexmo.github.io/api-standards/http-code/405/Tue, 31 Jul 2018 02:43:54 +0100https://nexmo.github.io/api-standards/http-code/405/ 405 The 405 HTTP code is used when an unsupported HTTP verb is used on a resource. Example response { "type": "https://developer.nexmo.com/api-errors#wrong-verb", "title": "Request method not allowed", "detail": "Request method 'OPTIONS' not supported", "instance": "797a8f199c45014ab7b08bfe9cc1c12c" }https://nexmo.github.io/api-standards/http-code/403/Tue, 31 Jul 2018 02:27:01 +0100https://nexmo.github.io/api-standards/http-code/403/ 403 The authenticated user can not make this request. This is not an authentication issue, this is an authorization issue (could be due to low balance, scope of the auth token used, etc). Important: We use 404 rather than 403 for invalid permissions as we don’t want to leak that the resource exists to another user Example response { "type": "https://developer.nexmo.com/api-errors/account/secret-management#maximum-secrets-allowed", "title": "Maxmimum number of secrets already met", "detail": "This account has reached maximum number of '2' allowed secrets", "instance": "797a8f199c45014ab7b08bfe9cc1c12c" }https://nexmo.github.io/api-standards/http-code/404/Tue, 31 Jul 2018 02:27:01 +0100https://nexmo.github.io/api-standards/http-code/404/ 404 The resource could not be found, or the authenticating user does not have access to the resource. We use 404 rather than 403 for invalid permissions as we don’t want to leak that the resource exists to another user Example response { "type": "https://developer.nexmo.com/api-errors#invalid-api-key", "title": "Invalid API Key", "detail": "API key 'ABC123' does not exist, or you do not have access", "instance": "797a8f199c45014ab7b08bfe9cc1c12c" }https://nexmo.github.io/api-standards/http-code/409/Tue, 31 Jul 2018 02:27:01 +0100https://nexmo.github.io/api-standards/http-code/409/ 409 The request could not be completed due to a conflict with the current state of the resource. The resource exists; however, the action could not be taken. The response MUST contain contain a description of the conflict. Example response { "type": "https://developer.nexmo.com/api-errors#conflict", "title": "Conflict", "detail": "This resource cannot be updated once the job has started running", "instance": "797a8f199c45014ab7b08bfe9cc1c12c" }https://nexmo.github.io/api-standards/http-code/410/Tue, 31 Jul 2018 02:27:01 +0100https://nexmo.github.io/api-standards/http-code/410/ 410 The requested resource is no longer available at the server. This condition is expected to be considered permanent. Used when the URI is formatted correctly, but the subresource is no long available. Example response { "type": "https://developer.nexmo.com/api-errors#gone", "title": "Gone", "detail": "The resource at this location no longer exists", "instance": "797a8f199c45014ab7b08bfe9cc1c12c" }https://nexmo.github.io/api-standards/http-code/429/Tue, 31 Jul 2018 02:27:01 +0100https://nexmo.github.io/api-standards/http-code/429/ 429 The 429 HTTP code is used when a consumer has exceeded their rate limit Example response { "type": "https://developer.nexmo.com/api-errors#rate-limited", "title": "Rate Limited", "detail": "You have exceeded your rate limit. You can try again at YYYY-MM-DD HH:mm:ss", "instance": "797a8f199c45014ab7b08bfe9cc1c12c" }https://nexmo.github.io/api-standards/http-code/500/Tue, 31 Jul 2018 02:27:01 +0100https://nexmo.github.io/api-standards/http-code/500/ 500 The 500 HTTP code is a generic code, like a 200 used in most cases when no more specific code applies Example response { "type": "https://developer.nexmo.com/api-errors#internal-error", "title": "Internal Error", "detail": "An internal error occured. Please try again shortly", "instance": "797a8f199c45014ab7b08bfe9cc1c12c" }https://nexmo.github.io/api-standards/http-code/204/Tue, 31 Jul 2018 02:26:33 +0100https://nexmo.github.io/api-standards/http-code/204/204 Generally used on a successful DELETE. As the resource has been deleted there is no body. Example response Empty response bodyhttps://nexmo.github.io/api-standards/http-code/400/Tue, 31 Jul 2018 02:26:33 +0100https://nexmo.github.io/api-standards/http-code/400/ 400 Used when the request body cannot be parsed, or it contains deceptive routing. If you’re looking for validation errors, HTTP 422 is what you’re looking for Example response { "type": "https://developer.nexmo.com/api-errors#invalid-json", "title": "Malformed JSON", "detail": "Malformed JSON payload.", "instance": "f94b4e56604e07e5e5ad5a7228618f81" }https://nexmo.github.io/api-standards/http-code/401/Tue, 31 Jul 2018 02:26:33 +0100https://nexmo.github.io/api-standards/http-code/401/ 401 Request is missing API authorization credentials, or those credentials are invalid. Example response { "type": "https://developer.nexmo.com/api-errors#unauthorized", "title": "Invalid credentials supplied", "detail": "You did not provide correct credentials.", "instance": "797a8f199c45014ab7b08bfe9cc1c12c" }https://nexmo.github.io/api-standards/http-code/202/Tue, 31 Jul 2018 02:25:26 +0100https://nexmo.github.io/api-standards/http-code/202/202 Acknowledges the request has been received, but not that the process has been completed. Used for asynchronous tasks, such as if the action will be placed in a queue, or depends on an external service with a slow response time. The response body should include status information and an identifier for the resource, such as a self link (some of our APIs return an ID here which is also acceptable).https://nexmo.github.io/api-standards/http-code/207/Tue, 31 Jul 2018 00:45:42 +0100https://nexmo.github.io/api-standards/http-code/207/ 207 A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate. This should not be used unless in exceptional circumstances Example response @TODO: Define this format { "multistatus": { "200": [{"example":"value"}], "400": [ { "payload": {"example":"value"}, "error": { "type": "https://example.net/validation-error", "title": "Your request parameters didn't validate.", "instance": "<trace_id>", "invalid_parameters": [ { "name": "age", "reason": "must be a positive integer" }, { "name": "color", "reason": "must be 'green', 'red' or 'blue'" } ] } } ] } }https://nexmo.github.io/api-standards/http-code/201/Tue, 31 Jul 2018 00:45:40 +0100https://nexmo.github.io/api-standards/http-code/201/ 201 Used when a new resource has been created. The body of the response should be the same as the GET representation of the new resource, including any generated/calculated fields. Example response { "_links": { "self": { "href": "https://api.nexmo.com/accounts/7c9738e6/secrets/ad6dc56f-07b5-46e1-a527-85530e625800" } }, "id": "ad6dc56f-07b5-46e1-a527-85530e625800", "created_at": "2017-03-02T16:34:49Z" }https://nexmo.github.io/api-standards/http-code/200/Tue, 31 Jul 2018 00:25:39 +0100https://nexmo.github.io/api-standards/http-code/200/200 The 200 HTTP code is used when the user’s request has been successful. This is our most commonly HTTP code and should be used for all successful requests, unless the request is a POST (see 201) or there are multiple status codes being returned (though this is discouraged, see 207) Example response { "_links": { "self": { "href": "https://api.nexmo.com/accounts/7c9738e6/secrets" } }, "_embedded": { "secrets": [ { "_links": { "self": { "href": "https://api.