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

List all links

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

Update a link

Next
Built with

Authentication

AuthorizationBasic

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

Query parameters

multiContainsobjectOptional
multiContains
multiEqualsobjectOptional
multiEquals
multiStartsWithobjectOptional
multiStartsWith
skipintegerOptional>=0Defaults to 0
skip
limitintegerOptional>=0Defaults to 25
limit
sortenumOptionalDefaults to name
sort
Allowed values:
orderenumOptionalDefaults to 1
order
Allowed values:

Response

The links matching the specified query.
resultsobject
This is the schema for an IAP external link stored in Mongo
totalinteger>=0
The total number of documents

Errors

500
Internal Server Error