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
    • Integration API routes
    • 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

Update a link

POST
http://localhost:3000/external-links
POST
/external-links
$curl -X POST http://localhost:3000/external-links \
> -H "Content-Type: application/json" \
> -u "<username>:<password>" \
> -d '{}'
1{
2 "status": "OK",
3 "message": "A sample success message",
4 "data": {
5 "name": "Google",
6 "address": "https://www.google.com/",
7 "description": "A link to Google",
8 "_meta": {
9 "created": "2018-08-02T15:56:12.912Z",
10 "updated": "2018-08-02T15:56:12.912Z"
11 }
12 }
13}
Creates a link.
Was this page helpful?
Previous

Update a link

Next
Built with

Authentication

AuthorizationBasic

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

Request

request body
linkobjectOptional
This is the schema for an IAP external link stored in Mongo

Response

Result of link creation process.
statusenum
The status of the API request.
Allowed values:
messagestring
Message containing either confirmation of the operation or the reason for the failure of the operation.
dataobject
This is the schema for an IAP external link stored in Mongo

Errors

500
Internal Server Error