# Introduction The Fenrir Cloud API allows you to interact with Fenrir Cloud and manage Applications, Deployments, and other resources using conventional HTTP requests. ## Authentication The Fenrir Cloud API uses API keys for the authentication. You can create new API keys in your Fenrir Cloud dashboard. Your bearer API key must be set in the \"Authorization\" header, for example: ```bash curl https://api.fenrircloud.com/1.0/api/applications \ -H \"Accept: application/json\" \ -H \"Authorization: Bearer FENRIR_API_KEY\" ``` ## Responses When a request is successful, a response body will typically contain a JSON object. For DELETE requests, a response with successful HTTP 204 NO_CONTENT status and a simple status will be returned. For other request, a JSON object will contain a requested object. If list of objects is requested, an array of them will be returned instead. ### Example Response (Single Object) ```json { \"application\": { \"name\": \"my-app\", ... } } ``` ### Example Response (Multiple Objects) ```json { \"applications\": [ { \"name\": \"my-app\", ... }, { \"name\": \"another-app\", ... } ] } ``` ## Error Handling Depending on the issue, a *4XX* status code will be returned. A body will contain a JSON object with the details of the message. Inside a JSON object, an error message will be included. For 400 Bad Request errors caused by validation issues, additional `errors` key will be set. That key will contain a list of ### Example Error Response ```json { \"message\": \"Invalid Request\", \"errors\": [ { \"field\": \"configuration.name\", \"error\": \"must not contain special characters\"] }, ... ] } ```
Raw data
{
"_id": null,
"home_page": "",
"name": "fenrir-api",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Fenrir Api",
"author": "OpenAPI Generator community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/f5/5b/d5ea3b2975ed51d89243c782de1f886a73b6aad5bb038690e0607757938f/fenrir-api-0.1.4.tar.gz",
"platform": null,
"description": " # Introduction The Fenrir Cloud API allows you to interact with Fenrir Cloud and manage Applications, Deployments, and other resources using conventional HTTP requests. ## Authentication The Fenrir Cloud API uses API keys for the authentication. You can create new API keys in your Fenrir Cloud dashboard. Your bearer API key must be set in the \\"Authorization\\" header, for example: ```bash curl https://api.fenrircloud.com/1.0/api/applications \\ -H \\"Accept: application/json\\" \\ -H \\"Authorization: Bearer FENRIR_API_KEY\\" ``` ## Responses When a request is successful, a response body will typically contain a JSON object. For DELETE requests, a response with successful HTTP 204 NO_CONTENT status and a simple status will be returned. For other request, a JSON object will contain a requested object. If list of objects is requested, an array of them will be returned instead. ### Example Response (Single Object) ```json { \\"application\\": { \\"name\\": \\"my-app\\", ... } } ``` ### Example Response (Multiple Objects) ```json { \\"applications\\": [ { \\"name\\": \\"my-app\\", ... }, { \\"name\\": \\"another-app\\", ... } ] } ``` ## Error Handling Depending on the issue, a *4XX* status code will be returned. A body will contain a JSON object with the details of the message. Inside a JSON object, an error message will be included. For 400 Bad Request errors caused by validation issues, additional `errors` key will be set. That key will contain a list of ### Example Error Response ```json { \\"message\\": \\"Invalid Request\\", \\"errors\\": [ { \\"field\\": \\"configuration.name\\", \\"error\\": \\"must not contain special characters\\"] }, ... ] } ``` \n \n",
"bugtrack_url": null,
"license": "",
"summary": "Fenrir Api",
"version": "0.1.4",
"project_urls": null,
"split_keywords": [
"openapi",
"openapi-generator",
"fenrir api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "715a444e6c8f4e79ab992f24cb3bdd553e63a920f4b914395d246e7345452b09",
"md5": "82fc290dda56385470b8cf8534c67403",
"sha256": "8ac30b5d2389f0a83c1d364aa202bd681964be3889f2265ec99222b1305f9a9c"
},
"downloads": -1,
"filename": "fenrir_api-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "82fc290dda56385470b8cf8534c67403",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 118051,
"upload_time": "2024-02-14T19:47:21",
"upload_time_iso_8601": "2024-02-14T19:47:21.158419Z",
"url": "https://files.pythonhosted.org/packages/71/5a/444e6c8f4e79ab992f24cb3bdd553e63a920f4b914395d246e7345452b09/fenrir_api-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f55bd5ea3b2975ed51d89243c782de1f886a73b6aad5bb038690e0607757938f",
"md5": "559d796c6775c7e100a7ee9e7ac9b45b",
"sha256": "01c9a199c25668e404d6fd4303e7b24fde1f5bdb817c6b8536291732b6e8bfb4"
},
"downloads": -1,
"filename": "fenrir-api-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "559d796c6775c7e100a7ee9e7ac9b45b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 44998,
"upload_time": "2024-02-14T19:47:22",
"upload_time_iso_8601": "2024-02-14T19:47:22.391170Z",
"url": "https://files.pythonhosted.org/packages/f5/5b/d5ea3b2975ed51d89243c782de1f886a73b6aad5bb038690e0607757938f/fenrir-api-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-14 19:47:22",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fenrir-api"
}
JSON