For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • DELDelete a link
        • GETGet an individual link
        • GETList all links
        • POSTUpdate a link
        • PATCHUpdate a link
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceExternal Links

Get an individual link

GET
http://localhost:3000/external-links/:linkId
GET
/external-links/:linkId
$curl http://localhost:3000/external-links/linkId \
>     -u "<username>:<password>"
1{
2  "name": "Google",
3  "address": "https://www.google.com/",
4  "description": "A link to Google",
5  "_meta": {
6    "created": "2018-08-02T15:56:12.912Z",
7    "updated": "2018-08-02T15:56:12.912Z"
8  }
9}
Returns an individual link.
Was this page helpful?
Previous

List all links

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

linkIdstringRequired
The id for the requested link.

Response

The individual link document.
namestringformat: "^(?![\s.]+$)[a-zA-Z\s.]*$">=1 character
addressstring>=1 character
descriptionstring
_metaobject

Errors

500
Internal Server Error