NerdGraph tutorial: Create, update, and revoke public sharing dashboard URLs

1. Go to NerdGraph API explorer.
2. Construct a graph API call using the following details:

• Mutation: dashboardCreateLiveUrl

• GUID: The entity guide of the dashboard

• Options(optional): The time period in seconds for the URL to be live

  • Minimum value: 300 seconds (5 minutes)
  • Maximum value: 631152000 seconds (20 years)
  • Default value: 2592000 seconds (30 days)

• Response: url

  mutation CreatePublicLink {
    dashboardCreateLiveUrl(
      guid: "YOUR_DASHBOARD_GUID"
      options: { ttl: "updated duration in seconds" }
    ) {
      url
    }
  }

  Copy

The live dashboard URL appears in the response. This is a public URL, so you can share it with anyone.

https://share.newrelic.com/dashboard/PUBLIC_LINK_ID

The PUBLIC_LINK_ID is the ID of the shared dashboard. You can use it to update or revoke the shared dashboard URL through NerdGraph.

Make sure you have the permissions to modify the configuration of the shared dashboard.

To update the time period for the URL to be live:

1. Go to NerdGraph API explorer.
2. Construct a graph API call using the following details:

• Mutation: dashboardUpdateLiveUrl

• ID: The ID of the shared dashboard (Copy it from the shared dashboard URL.)

• Options: The updated time period in seconds

  • Minimum value: 300 seconds (5 minutes)
  • Maximum value: 631152000 seconds (20 years)
  • Default value: 2592000 seconds (30 days)

  mutation UpdatePublicLink {
    dashboardUpdateLiveUrl(
      id: "enter the public link ID"
      options: { ttl: "updated duration in seconds" }
    ) {
      title
      url
    }
  }

  Copy

The URL appears in the response as follows. Now the URL will remain live for the updated time period.

https://share.newrelic.com/dashboard/PUBLIC_LINK_ID

Based on the permissions you have, you can revoke only the URLs you have created, or all URLs created by users in the account. To revoke a shared dashboard URL:

1. Go to NerdGraph API explorer.
2. Construct a graph API call using the following details:

• Mutation: dashboardRevokeLiveUrl

• ID: The ID of the shared dashboard (Copy it from the shared dashboard URL.)

  mutation {
    dashboardRevokeLiveUrl(id: "PUBLIC_LINK_ID") {
      id
    }
  }

  Copy

The shared dashboard URL is now revoked, and it will no longer be accessible. The response appears as follows:

{
  "data": {
    "dashboardRevokeLiveUrl": {
      "id": "PUBLIC_LINK_ID" //the one you passed to the mutation
    }
  }
}

Based on the permissions you have, you can retrieve the list of links you have created, or all links created by users in the account. To get the list of shared dashboard URLs:

1. Go to NerdGraph API explorer.
2. Construct a graph API call using the following details:

• Query: dashboard

• Response: liveUrls

  {
    actor {
      user {
        name
      }
      dashboard {
        liveUrls(filter: { type: DASHBOARD }) {
          liveUrls {
            createdAt
            type
            uuid
          }
        }
      }
    }
  }

  Copy

  The list of the shared dashboard URLs appears in response.