{"id":55246,"date":"2024-06-19T12:31:01","date_gmt":"2024-06-19T11:31:01","guid":{"rendered":"https:\/\/www.n-able.com\/?p=55246"},"modified":"2024-06-20T12:33:22","modified_gmt":"2024-06-20T11:33:22","slug":"getting-started-with-n-central-rest-apis-tips-and-tricks","status":"publish","type":"post","link":"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks","title":{"rendered":"Getting Started with N‑central REST APIs: Tips and Tricks"},"content":{"rendered":"

For some the term API can signal an immediate tune out. I have to admit, despite being in the IT game for 25 years now, I was one of those people. However, that changed to a degree when I took up the Head Nerd role here at N‑able, driven in no small part by the fact that I had to deliver a Head Nerd Boot Camp<\/span><\/a> on Leveraging APIs in N‑central. Unfortunately, these APIs were SOAP based, hadn\u2019t had much development in recent years, and weren\u2019t exactly easy to work with.<\/span><\/p>\n

That all changed though late in 2023, with the release of N‑central 2023.9, which brought brand new REST APIs. Now some people may argue that SOAP are better than REST, but it\u2019s my blog so I\u2019m telling you, that REST APIs are a lot easier to use and work with than SOAP APIs<\/span><\/a>\u2014hence they are better in my opinion. If you have been avoiding using APIs before in N‑central or maybe looked at the old SOAP APIs and thought, these aren\u2019t for me, then now\u2019s the time to look at them again. In this blog, I\u2019m going to give you some ideas on how you can work with the new REST APIs in N‑central and remove the apprehension you might have had working with them.<\/span><\/p>\n

These new APIs have got Swagger!<\/b><\/span><\/h2>\n

First up we are going to start with how you access the REST APIs, this is the easy part: just throw a <\/span>\/api-explorer <\/span>onto the end of your N‑central URL and boom you\u2019re in Swagger. What\u2019s Swagger I hear you aks? Swagger is an open-source framework that allows developers to design, document, and consume REST APIs. Swagger simplifies API development by facilitating the creation of comprehensive, well-structured, and easily understandable API documentation. In here you will see all the categories of APIs available on your version of N‑central, and you can expand each category to see what functions are available under each one as well. Clicking on a function will also tell you what parameters are used, including which of these parameters are required in order to run the API call. Scroll a little further down the page and you\u2019ll find the Schemas, think of this as your dictionary that explains all the information that the API calls retrieve, this can save you time as you can ensure the information you are looking for is retrievable.<\/span><\/p>\n

Now, when it comes to using APIs, typically we\u2019re going to use scripts for that, but sometimes you just want to confirm the API function has the information you\u2019re looking for\u2014Swagger is great for this too. You can authenticate and execute the functions all from within the Swagger interface. If you want to know how to create an API-Only User for your N‑central server and authenticate using Swagger, then head over to or brand new Developer Portal<\/span><\/a>, where you\u2019ll find two short videos on how to do just that.<\/span><\/p>\n

Can I still use these APIs if scripting isn\u2019t my thing?<\/b><\/span><\/h2>\n

The first steps can always be the hardest, and if you haven\u2019t done a ton of scripting before then the idea of building scripts that use the API functions can be off-putting. Thankfully there\u2019s a little thing that we pretty much hear about every day that can help\u2014Generative AI. You can use tools like ChatGPT to create the scripts for you. For Example, you could ask it to create a PowerShell script using the information available on YourN‑centralURL\/api-explorer <\/i>to create a script that will export all your devices to a local CSV file. You can play around with the information you are looking for in terms of what columns you wish to include and how to organize them. Remember to reference the information that\u2019s in the Swagger UI to have a generative AI tool build exactly what you need.<\/span><\/p>\n

A little knowledge goes a long way<\/b><\/span><\/h2>\n

If you\u2019ve dabbled a bit in scripting already, and you\u2019re not quite ready to cede your job to computers, but you\u2019d still like a bump to get you started. Then fear not! The N‑able Automation Cookbook<\/span><\/a> is here to help. Once in there, search for the NC REST API scripts. These sample scripts can be used individually or combined, viewing these scripts will help you understand how they are constructed and are a quick way of learning how you can interact with these API functions. I\u2019ll be personally looking to grow this library of scripts as new API calls are added to N‑central, so don\u2019t forget to check in regularly to see what additional scripts are available.<\/span><\/p>\n

These are just a few examples that will help you better leverage APIs to enhance how you use N‑central to manage and maintain your customers. If you haven\u2019t been using APIs up to this point, hopefully this blog will inspire you to do so.<\/span><\/p>\n

If you have questions join me on the N-Central office hours or register for our Leveraging REST APIs in N‑central Boot Camp, check the schedule at <\/b>www.n-able.com\/events<\/b><\/span><\/a>.<\/b><\/span><\/p>\n

Paul Kelly is the Head Nerd at N\u2011able. You can follow him on Twitter at\u00a0<\/i>@HeadNerdPaul<\/i><\/span><\/span><\/a>,\u00a0<\/i>LinkedIn<\/i><\/span><\/span><\/a>\u00a0and Reddit at\u00a0<\/i>u\/Paul _Kelly<\/i><\/span><\/span><\/a>. Alternatively you can\u00a0<\/i>email me direct<\/i><\/span><\/span><\/a>.<\/i><\/p>\n","protected":false},"excerpt":{"rendered":"

With REST APIs coming to N-central in 2023.9, Paul Kelly looks at how you can make effectively work with them.<\/p>\n","protected":false},"author":95,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"class_list":["post-55246","post","type-post","status-publish","format-standard","hentry","topic-automation","topic-head-nerds"],"acf":[],"yoast_head":"\nGetting Started with N-central REST APIs: Tips and Tricks - N-able<\/title>\n<meta name=\"description\" content=\"With REST APIs coming to N-central in 2023.9, Paul Kelly looks at how you can make effectively work with them.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks\" \/>\n<meta property=\"og:locale\" content=\"pt_BR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Getting Started with N-central REST APIs: Tips and Tricks - N-able\" \/>\n<meta property=\"og:description\" content=\"With REST APIs coming to N-central in 2023.9, Paul Kelly looks at how you can make effectively work with them.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks\" \/>\n<meta property=\"og:site_name\" content=\"N-able\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/NableMSP\" \/>\n<meta property=\"article:published_time\" content=\"2024-06-19T11:31:01+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-06-20T11:33:22+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.n-able.com\/wp-content\/uploads\/2024\/06\/061924_BB_NCentral-REST-API_PD_1200x628_Final-scaled.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"2560\" \/>\n\t<meta property=\"og:image:height\" content=\"1340\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Paul Kelly\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@Nable\" \/>\n<meta name=\"twitter:site\" content=\"@Nable\" \/>\n<meta name=\"twitter:label1\" content=\"Escrito por\" \/>\n\t<meta name=\"twitter:data1\" content=\"Paul Kelly\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. tempo de leitura\" \/>\n\t<meta name=\"twitter:data2\" content=\"4 minutos\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks\"},\"author\":{\"name\":\"Paul Kelly\",\"@id\":\"https:\/\/www.n-able.com\/pt-br#\/schema\/person\/b314d1740d99089064deb1b842afe108\"},\"headline\":\"Getting Started with N‑central REST APIs: Tips and Tricks\",\"datePublished\":\"2024-06-19T12:31:01+01:00\",\"dateModified\":\"2024-06-20T11:33:22+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks\"},\"wordCount\":898,\"publisher\":{\"@id\":\"https:\/\/www.n-able.com\/pt-br#organization\"},\"articleSection\":[\"Automation\",\"Head Nerds\"],\"inLanguage\":\"pt-BR\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks\",\"url\":\"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks\",\"name\":\"Getting Started with N-central REST APIs: Tips and Tricks - N-able\",\"isPartOf\":{\"@id\":\"https:\/\/www.n-able.com\/pt-br#website\"},\"datePublished\":\"2024-06-19T12:31:01+01:00\",\"dateModified\":\"2024-06-20T11:33:22+00:00\",\"description\":\"With REST APIs coming to N-central in 2023.9, Paul Kelly looks at how you can make effectively work with them.\",\"breadcrumb\":{\"@id\":\"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks#breadcrumb\"},\"inLanguage\":\"pt-BR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Head Nerds\",\"item\":\"https:\/\/www.n-able.com\/pt-br\/blog\/category\/head-nerds-pt-br\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Getting Started with N‑central REST APIs: Tips and Tricks\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.n-able.com\/pt-br#website\",\"url\":\"https:\/\/www.n-able.com\/pt-br\",\"name\":\"N-able\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/www.n-able.com\/pt-br#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.n-able.com\/pt-br?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"pt-BR\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.n-able.com\/pt-br#organization\",\"name\":\"N-able\",\"url\":\"https:\/\/www.n-able.com\/pt-br\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"pt-BR\",\"@id\":\"https:\/\/www.n-able.com\/pt-br#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.n-able.com\/wp-content\/uploads\/2021\/02\/logo-n-able-vertical-dark.svg\",\"contentUrl\":\"https:\/\/www.n-able.com\/wp-content\/uploads\/2021\/02\/logo-n-able-vertical-dark.svg\",\"width\":\"1024\",\"height\":\"1024\",\"caption\":\"N-able\"},\"image\":{\"@id\":\"https:\/\/www.n-able.com\/pt-br#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/NableMSP\",\"https:\/\/x.com\/Nable\",\"https:\/\/www.linkedin.com\/company\/n-able\",\"https:\/\/www.youtube.com\/channel\/UClnp77HHg4aME-S-3fWQhFw\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.n-able.com\/pt-br#\/schema\/person\/b314d1740d99089064deb1b842afe108\",\"name\":\"Paul Kelly\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"pt-BR\",\"@id\":\"https:\/\/secure.gravatar.com\/avatar\/5eb43befb5968c33993074c123ae2d65fe5fd7bc9b1856586f8cb3a366c6bc65?s=96&d=mm&r=g\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/5eb43befb5968c33993074c123ae2d65fe5fd7bc9b1856586f8cb3a366c6bc65?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/5eb43befb5968c33993074c123ae2d65fe5fd7bc9b1856586f8cb3a366c6bc65?s=96&d=mm&r=g\",\"caption\":\"Paul Kelly\"}}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Getting Started with N-central REST APIs: Tips and Tricks - N-able","description":"With REST APIs coming to N-central in 2023.9, Paul Kelly looks at how you can make effectively work with them.","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:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks","og_locale":"pt_BR","og_type":"article","og_title":"Getting Started with N-central REST APIs: Tips and Tricks - N-able","og_description":"With REST APIs coming to N-central in 2023.9, Paul Kelly looks at how you can make effectively work with them.","og_url":"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks","og_site_name":"N-able","article_publisher":"https:\/\/www.facebook.com\/NableMSP","article_published_time":"2024-06-19T11:31:01+00:00","article_modified_time":"2024-06-20T11:33:22+00:00","og_image":[{"width":2560,"height":1340,"url":"https:\/\/www.n-able.com\/wp-content\/uploads\/2024\/06\/061924_BB_NCentral-REST-API_PD_1200x628_Final-scaled.jpg","type":"image\/jpeg"}],"author":"Paul Kelly","twitter_card":"summary_large_image","twitter_creator":"@Nable","twitter_site":"@Nable","twitter_misc":{"Escrito por":"Paul Kelly","Est. tempo de leitura":"4 minutos"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks#article","isPartOf":{"@id":"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks"},"author":{"name":"Paul Kelly","@id":"https:\/\/www.n-able.com\/pt-br#\/schema\/person\/b314d1740d99089064deb1b842afe108"},"headline":"Getting Started with N‑central REST APIs: Tips and Tricks","datePublished":"2024-06-19T12:31:01+01:00","dateModified":"2024-06-20T11:33:22+00:00","mainEntityOfPage":{"@id":"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks"},"wordCount":898,"publisher":{"@id":"https:\/\/www.n-able.com\/pt-br#organization"},"articleSection":["Automation","Head Nerds"],"inLanguage":"pt-BR"},{"@type":"WebPage","@id":"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks","url":"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks","name":"Getting Started with N-central REST APIs: Tips and Tricks - N-able","isPartOf":{"@id":"https:\/\/www.n-able.com\/pt-br#website"},"datePublished":"2024-06-19T12:31:01+01:00","dateModified":"2024-06-20T11:33:22+00:00","description":"With REST APIs coming to N-central in 2023.9, Paul Kelly looks at how you can make effectively work with them.","breadcrumb":{"@id":"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks#breadcrumb"},"inLanguage":"pt-BR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.n-able.com\/pt-br\/blog\/getting-started-with-n-central-rest-apis-tips-and-tricks#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Head Nerds","item":"https:\/\/www.n-able.com\/pt-br\/blog\/category\/head-nerds-pt-br"},{"@type":"ListItem","position":2,"name":"Getting Started with N‑central REST APIs: Tips and Tricks"}]},{"@type":"WebSite","@id":"https:\/\/www.n-able.com\/pt-br#website","url":"https:\/\/www.n-able.com\/pt-br","name":"N-able","description":"","publisher":{"@id":"https:\/\/www.n-able.com\/pt-br#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.n-able.com\/pt-br?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"pt-BR"},{"@type":"Organization","@id":"https:\/\/www.n-able.com\/pt-br#organization","name":"N-able","url":"https:\/\/www.n-able.com\/pt-br","logo":{"@type":"ImageObject","inLanguage":"pt-BR","@id":"https:\/\/www.n-able.com\/pt-br#\/schema\/logo\/image\/","url":"https:\/\/www.n-able.com\/wp-content\/uploads\/2021\/02\/logo-n-able-vertical-dark.svg","contentUrl":"https:\/\/www.n-able.com\/wp-content\/uploads\/2021\/02\/logo-n-able-vertical-dark.svg","width":"1024","height":"1024","caption":"N-able"},"image":{"@id":"https:\/\/www.n-able.com\/pt-br#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/NableMSP","https:\/\/x.com\/Nable","https:\/\/www.linkedin.com\/company\/n-able","https:\/\/www.youtube.com\/channel\/UClnp77HHg4aME-S-3fWQhFw"]},{"@type":"Person","@id":"https:\/\/www.n-able.com\/pt-br#\/schema\/person\/b314d1740d99089064deb1b842afe108","name":"Paul Kelly","image":{"@type":"ImageObject","inLanguage":"pt-BR","@id":"https:\/\/secure.gravatar.com\/avatar\/5eb43befb5968c33993074c123ae2d65fe5fd7bc9b1856586f8cb3a366c6bc65?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/5eb43befb5968c33993074c123ae2d65fe5fd7bc9b1856586f8cb3a366c6bc65?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/5eb43befb5968c33993074c123ae2d65fe5fd7bc9b1856586f8cb3a366c6bc65?s=96&d=mm&r=g","caption":"Paul Kelly"}}]}},"_links":{"self":[{"href":"https:\/\/www.n-able.com\/pt-br\/wp-json\/wp\/v2\/posts\/55246","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.n-able.com\/pt-br\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.n-able.com\/pt-br\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.n-able.com\/pt-br\/wp-json\/wp\/v2\/users\/95"}],"replies":[{"embeddable":true,"href":"https:\/\/www.n-able.com\/pt-br\/wp-json\/wp\/v2\/comments?post=55246"}],"version-history":[{"count":0,"href":"https:\/\/www.n-able.com\/pt-br\/wp-json\/wp\/v2\/posts\/55246\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.n-able.com\/pt-br\/wp-json\/wp\/v2\/media?parent=55246"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}