{"id":685,"date":"2024-09-26T09:22:14","date_gmt":"2024-09-26T09:22:14","guid":{"rendered":"https:\/\/opticalbackup.com\/help\/?post_type=tesserakb&#038;p=685"},"modified":"2024-12-16T11:27:26","modified_gmt":"2024-12-16T11:27:26","slug":"how-to-create-a-api-key","status":"publish","type":"tesserakb","link":"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/","title":{"rendered":"How to create an API key?"},"content":{"rendered":"<h3>Secure Your OpticalBackup Account with API Keys<\/h3>\n<p>When using the <strong>OpticalBackup desktop app<\/strong> for <strong>Windows<\/strong>, <strong>Mac<\/strong>, or <strong>Linux<\/strong>, or accessing our API service, authentication is required via an <strong>API key<\/strong>. This ensures secure communication between your computer and our servers, protecting your data and account. You can generate and revoke API keys as needed to maintain optimal security.<\/p>\n<p>For detailed instructions on using an API key with the <strong>OpticalBackup desktop app<\/strong>, please refer to our tutorial: <strong>&#8220;How to Connect My App to My Account?&#8221;<\/strong><\/p>\n<h3>How to Generate an API Key:<\/h3>\n<p>Go to your personal menu and click on the <strong>&#8220;API&#8221;<\/strong> link.<\/p>\n<p><img fetchpriority=\"high\" decoding=\"async\" class=\"size-large wp-image-588 aligncenter\" src=\"https:\/\/opticalbackup.com\/help_pt\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu-1024x570.png\" alt=\"\" width=\"1024\" height=\"570\" srcset=\"https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu-1024x570.png 1024w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu-300x167.png 300w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu-768x428.png 768w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu-1536x856.png 1536w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu-2048x1141.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/p>\n<p>&nbsp;<\/p>\n<p>In the <strong>&#8220;Create API Tokens&#8221;<\/strong> section, assign a name to your API key, select its duration, and click the <strong>&#8220;Create&#8221;<\/strong> button.<\/p>\n<p><img decoding=\"async\" class=\"size-large wp-image-616 aligncenter\" src=\"https:\/\/opticalbackup.com\/help_pt\/wp-content\/uploads\/2024\/09\/api-token-pannel-1024x570.png\" alt=\"\" width=\"1024\" height=\"570\" srcset=\"https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/api-token-pannel-1024x570.png 1024w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/api-token-pannel-300x167.png 300w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/api-token-pannel-768x428.png 768w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/api-token-pannel-1536x856.png 1536w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/api-token-pannel-2048x1141.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/p>\n<p>You will then be shown the <strong>API token<\/strong> (a long string of characters). This token will only be displayed once. It\u2019s important to keep it secure, as anyone with access to this API token can gain access to your account. Ensure you save it in a safe place, as it will not be displayed again on your dashboard.<\/p>\n<p><img decoding=\"async\" class=\"size-large wp-image-687 aligncenter\" src=\"https:\/\/opticalbackup.com\/help_pt\/wp-content\/uploads\/2024\/09\/api-key-1-1024x570.png\" alt=\"\" width=\"1024\" height=\"570\" srcset=\"https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/api-key-1-1024x570.png 1024w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/api-key-1-300x167.png 300w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/api-key-1-768x428.png 768w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/api-key-1-1536x856.png 1536w, https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/api-key-1-2048x1141.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/p>\n<h3>Managing and Revoking API Keys:<\/h3>\n<p>If you suspect that an API key has been compromised, you can easily delete it to prevent further access. Simply navigate to the <strong>&#8220;Manage API Tokens&#8221;<\/strong> section, locate the compromised key, and delete it to block access.<\/p>\n<p>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Secure Your OpticalBackup Account with API Keys When using the OpticalBackup desktop app for Windows, Mac, or Linux, or accessing our API service, authentication is required via an API key. This ensures secure communication between your computer and our servers, protecting your data and account. You can generate and revoke API keys as needed to&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"_acf_changed":false,"tessera_post_format_link":""},"tesserakbcats":[25],"tesserakbtags":[],"class_list":["post-685","tesserakb","type-tesserakb","status-publish","format-standard","hentry","tesserakbcats-developers-api"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.3 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>How to create Opticalbackup API Keys for Desktop and API Access<\/title>\n<meta name=\"description\" content=\"Learn how to secure your OpticalBackup account with API keys for desktop apps and API services. Generate, manage, and revoke API tokens for safe, authenticated access to your data.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Protect Your Data: Secure Your OpticalBackup Account with API Keys\" \/>\n<meta property=\"og:description\" content=\"Keep your OpticalBackup account secure with API keys! Learn how to generate and manage API tokens for authenticated access via desktop apps and API services. Start protecting your data today.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/\" \/>\n<meta property=\"og:site_name\" content=\"OpticalBackup Knowledge Base\" \/>\n<meta property=\"article:modified_time\" content=\"2024-12-16T11:27:26+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/opticalbackup.com\/help_pt\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu-1024x570.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/\",\"url\":\"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/\",\"name\":\"How to create Opticalbackup API Keys for Desktop and API Access\",\"isPartOf\":{\"@id\":\"https:\/\/opticalbackup.com\/help\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/opticalbackup.com\/help_pt\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu-1024x570.png\",\"datePublished\":\"2024-09-26T09:22:14+00:00\",\"dateModified\":\"2024-12-16T11:27:26+00:00\",\"description\":\"Learn how to secure your OpticalBackup account with API keys for desktop apps and API services. Generate, manage, and revoke API tokens for safe, authenticated access to your data.\",\"breadcrumb\":{\"@id\":\"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/#primaryimage\",\"url\":\"https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu.png\",\"contentUrl\":\"https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu.png\",\"width\":2079,\"height\":1158},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/opticalbackup.com\/help\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Articles\",\"item\":\"https:\/\/opticalbackup.com\/help\/knowledgebase\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"How to create an API key?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/opticalbackup.com\/help\/#website\",\"url\":\"https:\/\/opticalbackup.com\/help\/\",\"name\":\"OpticalBackup Knowledge Base\",\"description\":\"Protect What Matters Immutable. Optical. Secure.\",\"publisher\":{\"@id\":\"https:\/\/opticalbackup.com\/help\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/opticalbackup.com\/help\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/opticalbackup.com\/help\/#organization\",\"name\":\"OpticalBackup Knowledge Base\",\"url\":\"https:\/\/opticalbackup.com\/help\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/opticalbackup.com\/help\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/cropped-optical-backup-Logo-transparente-branco-.png\",\"contentUrl\":\"https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/cropped-optical-backup-Logo-transparente-branco-.png\",\"width\":500,\"height\":167,\"caption\":\"OpticalBackup Knowledge Base\"},\"image\":{\"@id\":\"https:\/\/opticalbackup.com\/help\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to create Opticalbackup API Keys for Desktop and API Access","description":"Learn how to secure your OpticalBackup account with API keys for desktop apps and API services. Generate, manage, and revoke API tokens for safe, authenticated access to your data.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/","og_locale":"en_US","og_type":"article","og_title":"Protect Your Data: Secure Your OpticalBackup Account with API Keys","og_description":"Keep your OpticalBackup account secure with API keys! Learn how to generate and manage API tokens for authenticated access via desktop apps and API services. Start protecting your data today.","og_url":"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/","og_site_name":"OpticalBackup Knowledge Base","article_modified_time":"2024-12-16T11:27:26+00:00","og_image":[{"url":"https:\/\/opticalbackup.com\/help_pt\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu-1024x570.png","type":"","width":"","height":""}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/","url":"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/","name":"How to create Opticalbackup API Keys for Desktop and API Access","isPartOf":{"@id":"https:\/\/opticalbackup.com\/help\/#website"},"primaryImageOfPage":{"@id":"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/#primaryimage"},"image":{"@id":"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/#primaryimage"},"thumbnailUrl":"https:\/\/opticalbackup.com\/help_pt\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu-1024x570.png","datePublished":"2024-09-26T09:22:14+00:00","dateModified":"2024-12-16T11:27:26+00:00","description":"Learn how to secure your OpticalBackup account with API keys for desktop apps and API services. Generate, manage, and revoke API tokens for safe, authenticated access to your data.","breadcrumb":{"@id":"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/#primaryimage","url":"https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu.png","contentUrl":"https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/dashboard-personal-menu.png","width":2079,"height":1158},{"@type":"BreadcrumbList","@id":"https:\/\/opticalbackup.com\/help\/knowledgebase\/how-to-create-a-api-key\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/opticalbackup.com\/help\/"},{"@type":"ListItem","position":2,"name":"Articles","item":"https:\/\/opticalbackup.com\/help\/knowledgebase\/"},{"@type":"ListItem","position":3,"name":"How to create an API key?"}]},{"@type":"WebSite","@id":"https:\/\/opticalbackup.com\/help\/#website","url":"https:\/\/opticalbackup.com\/help\/","name":"OpticalBackup Knowledge Base","description":"Protect What Matters Immutable. Optical. Secure.","publisher":{"@id":"https:\/\/opticalbackup.com\/help\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/opticalbackup.com\/help\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/opticalbackup.com\/help\/#organization","name":"OpticalBackup Knowledge Base","url":"https:\/\/opticalbackup.com\/help\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/opticalbackup.com\/help\/#\/schema\/logo\/image\/","url":"https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/cropped-optical-backup-Logo-transparente-branco-.png","contentUrl":"https:\/\/opticalbackup.com\/help\/wp-content\/uploads\/2024\/09\/cropped-optical-backup-Logo-transparente-branco-.png","width":500,"height":167,"caption":"OpticalBackup Knowledge Base"},"image":{"@id":"https:\/\/opticalbackup.com\/help\/#\/schema\/logo\/image\/"}}]}},"jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/opticalbackup.com\/help\/wp-json\/wp\/v2\/tesserakb\/685","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/opticalbackup.com\/help\/wp-json\/wp\/v2\/tesserakb"}],"about":[{"href":"https:\/\/opticalbackup.com\/help\/wp-json\/wp\/v2\/types\/tesserakb"}],"author":[{"embeddable":true,"href":"https:\/\/opticalbackup.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/opticalbackup.com\/help\/wp-json\/wp\/v2\/comments?post=685"}],"wp:attachment":[{"href":"https:\/\/opticalbackup.com\/help\/wp-json\/wp\/v2\/media?parent=685"}],"wp:term":[{"taxonomy":"tesserakbcats","embeddable":true,"href":"https:\/\/opticalbackup.com\/help\/wp-json\/wp\/v2\/tesserakbcats?post=685"},{"taxonomy":"tesserakbtags","embeddable":true,"href":"https:\/\/opticalbackup.com\/help\/wp-json\/wp\/v2\/tesserakbtags?post=685"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}