{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Response Codes","description":"The best API documentation generator ever.","siteUrl":"https://developer-portal-starter.redoc.ly","keywords":"redocly developer portal, api portal starter, api reference docs","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"response-codes","__idx":0},"children":["Response Codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API requests receive a response with the appropriate ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://en.wikipedia.org/wiki/List_of_HTTP_status_codes"},"children":["HTTP response code"]},". Each response class represents a different general message:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["2XX codes - successful responses."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["4XX codes - client error responses. There was an error in your request. Modify the request and try again. The 4XX error codes are listed in the table below."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["5XX codes - server error responses. There may be a temporary issue on the Lytx side."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-codes","__idx":1},"children":["Error codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following is a table of error codes to help you debug:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status Code"},"children":["Status Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bad request - general client error, possibly malformed data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unauthenticated - the API key is missing or invalid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not found - the API endpoint is invalid or a path parameter is missing or invalid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["405"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Method not allowed - the API endpoint does not accept that HTTP method."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["5XX"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal server errors - something went wrong with the Lytx API's servers. These responses are likely a temporary error, so try again in a few minutes."]}]}]}]}]}]},"headings":[{"value":"Response Codes","id":"response-codes","depth":1},{"value":"Error codes","id":"error-codes","depth":2}],"frontmatter":{"seo":{"title":"Response Codes"}},"lastModified":"2024-04-10T22:15:25.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/responsecodes","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}