Tutoriel NerdGraph : créer, mettre à jour et révoquer les URL dashboard de partage public

Avec la sécurité et l'accès nécessaires configurés, vous pouvez créer, gérer et révoquer les URL de dashboard en direct accessibles au public à l'aide de requêtes et de mutations dans NerdGraph. Vous pouvez également le faire à partir de l' UI de New Relic.

Prudence

Si un dashboard partagé n'est pas protégé par mot de passe, toute personne disposant de l'URL en direct peut accéder et afficher toutes les informations qu'il contient. Pour éviter tout accès indésirable, assurez-vous de créer des URL protégées par mot de passe ou d'activer la protection par mot de passe pour les URL partagées existantes.

Pour créer, mettre à jour ou révoquer une URL dashboard en direct accessible au public à partir de NerdGraph, vous avez besoin du GUID du dashboard que vous souhaitez partager.

Allez à one.newrelic.com > Dashboards.
Ouvrez le dashboard que vous souhaitez partager.
Accédez à > Metadata et copiez le GUID d’entité du dashboard.

Accédez à l'explorateur d'API NerdGraph.
Construisez un graphe appelé d'API en utilisant la mutation dashboardCreateLiveUrl avec les paramètres suivants :

GUID: Entrez le GUID de l'entité du dashboard.
Options(facultatif) > ttl: saisissez la période en secondes pendant laquelle l'URL doit être active.
- Valeur minimale: 300 secondes (5 minutes)
- Valeur maximale: 631152000 secondes (20 ans)
- Valeur par défaut: 2592000 secondes (30 jours)
url: Sélectionnez cette option pour obtenir l’URL dashboard en direct dans la réponse.
Sélectionnez tous les autres champs que vous souhaitez dans la réponse.
Mutation d'échantillon
```
mutation {
  dashboardCreateLiveUrl(
    options: {ttl: time in seconds}
    guid: "YOUR_DASHBOARD_GUID"
  ) {
    url
  }
}
```
L'URL dashboard en direct apparaît dans la réponse. Il s'agit d'une URL publique, vous pouvez donc la partager avec n'importe qui.
Exemple de réponse
```
{
  "data": {
    "dashboardCreateLiveUrl": {
      "url": "https://share.newrelic.com/dashboard/PUBLIC_LINK_ID"
    }
  }
}
```
Le PUBLIC_LINK_ID est l'ID du dashboard partagé. Vous pouvez l'utiliser pour mettre à jour ou révoquer l'URL dashboard partagé via NerdGraph.
Important
Toute mise à jour de contenu dans le dashboard sur la plateforme New Relic se reflète sur la page dashboard partagé.

Pour éviter tout accès indésirable au dashboard partagé, vous pouvez créer une URL dashboard en direct avec protection par mot de passe.

Accédez à l'explorateur d'API NerdGraph.
Construisez un graphe appelé d'API en utilisant la mutation dashboardCreateLiveUrl avec les paramètres suivants :

auth > factors > type: Sélectionnez PASSWORD pour activer la protection par mot de passe pour l'URL dashboard en direct.
GUID: Entrez le GUID de l'entité du dashboard.
Options(facultatif) > ttl: saisissez la période en secondes pendant laquelle l'URL doit être active.
- Valeur minimale: 300 secondes (5 minutes)
- Valeur maximale: 631152000 secondes (20 ans)
- Valeur par défaut: 2592000 secondes (30 jours)
auth > factors > password > value: Sélectionnez cette option pour obtenir le mot de passe dashboard en direct dans la réponse.
url: Sélectionnez cette option pour obtenir l’URL dashboard en direct dans la réponse.

Sélectionnez tous les autres champs que vous souhaitez dans la réponse.

Mutation d'échantillon

mutation {
  dashboardCreateLiveUrl(
    guid: "YOUR_DASHBOARD_GUID"
    options: { ttl: 3600 } # Optional: Set a time-to-live for the URL
    auth: { factors: [{ type: PASSWORD }] }
  ) {
    url
    uuid
    auth {
      factors {
        type
        password {
          value # REQUEST THE PASSWORD VALUE HERE
        }
      }
    }
  }
}

L'URL et le mot de passe dashboard en direct apparaissent dans la réponse.

Exemple de réponse

{
  "data": {
    "dashboardCreateLiveUrl": {
      "auth": {
        "factors": [
          {
            "password": {
              "value": "pfd-3ZZ46#3a4On5p%&¿"
            },
            "type": "PASSWORD"
          }
        ]
      },
      "url": "https://one.newrelic.com/dashboard/f6c730bf-fced-4890-ad6e-86ab6a6e8159",
      "uuid": "f6c730bf-fced-4890-ad6e-86ab6a6e8159"
    }
  }
}

Le uuid est l'ID du dashboard partagé. Vous pouvez l'utiliser pour mettre à jour ou révoquer l'URL du tableau de bord partagé via NerdGraph. Pour partager le dashboard avec un utilisateur externe, copiez l'URL et le mot de passe de la réponse. Les mots de passe ne peuvent pas être récupérés ultérieurement. Si vous le perdez, il vous suffit de réinitialiser le mot de passe et de le partager à nouveau avec l'utilisateur. Suivez nos bonnes pratiques de gestion des mots de passe pour gérer le mot de passe en toute sécurité.

Assurez-vous que vous disposez des autorisations pour modifier la configuration du dashboard partagé.

Pour mettre à jour la période pendant laquelle l'URL doit être active :

Accédez à l'explorateur d'API NerdGraph.
Construisez un graphe appelé d'API en utilisant la mutation dashboardUpdateLiveUrl avec les paramètres suivants :

id:Copiez l’ID de l’URL dashboard partagé et saisissez-le.
Options (facultatif) > ttl: saisissez la période en secondes pendant laquelle l'URL doit être active.
- Valeur minimale: 300 secondes (5 minutes)
- Valeur maximale: 631152000 secondes (20 ans)
- Valeur par défaut: 2592000 secondes (30 jours)
Mutation d'échantillon
```
mutation {
  dashboardUpdateLiveUrl(
    id: "enter the public URL ID"
    options: { ttl: "updated duration in seconds" }
  )
}
```
L'URL apparaît dans la réponse comme suit. Désormais, l'URL restera active pendant la période mise à jour.
Exemple de réponse
```
{
  "data": {
    "dashboardUpdateLiveUrl": {
      "url": "https://share.newrelic.com/dashboard/PUBLIC_LINK_ID"
    }
  }
}
```

Assurez-vous que vous disposez des autorisations nécessaires pour modifier la configuration du dashboard partagé. Pour activer la protection par mot de passe pour une URL dashboard en direct :

Accédez à l'explorateur d'API NerdGraph.
Construisez un graphe appelé d'API en utilisant la mutation dashboardUpdateLiveUrlAuth avec les paramètres suivants :

auth > factors > type: Sélectionnez PASSWORD pour activer la protection par mot de passe pour l'URL dashboard en direct.
id:Copiez l’ID de l’URL dashboard partagé et saisissez-le.
auth > factors > password > value: Sélectionnez cette option pour obtenir le mot de passe dashboard en direct dans la réponse.
Sélectionnez tous les autres champs que vous souhaitez dans la réponse.
Mutation d'échantillon
```
mutation {
  dashboardUpdateLiveUrlAuth(
    id: "YOUR_PUBLIC_LINK_UUID"
    auth: { factors: [{ type: PASSWORD }] }
  ) {
    factors {
      password {
        value # A NEW PASSWORD WILL BE GENERATED AND RETURNED
      }
      type
    }
  }
}
```
Exemple de réponse
Le mot de passe apparaît dans la réponse comme suit.
```
{
  "data": {
    "dashboardUpdateLiveUrlAuth": {
      "factors": [
        {
          "password": {
            "value": "system generated password"
          },
          "type": "PASSWORD"
        }
      ]
    }
  }
}
```
Après avoir activé le mot de passe pour le tableau de bord partagé, vous devez partager le mot de passe avec l'utilisateur. Copiez et enregistrez le mot de passe, car vous ne pourrez pas le récupérer ultérieurement. Si vous le perdez, il vous suffit de réinitialiser le mot de passe et de le partager à nouveau avec l'utilisateur. Suivez nos bonnes pratiques de gestion des mots de passe pour gérer le mot de passe en toute sécurité.

Assurez-vous que vous disposez des autorisations nécessaires pour modifier la configuration du dashboard partagé. Pour désactiver la protection par mot de passe pour une URL dashboard en direct :

Accédez à l'explorateur d'API NerdGraph.
Construisez un graphe appelé d'API en utilisant la mutation dashboardUpdateLiveUrlAuth avec les valeurs d'attribut suivantes :

auth > factors > type: Sélectionnez PASSWORD pour activer la protection par mot de passe pour l'URL dashboard en direct.
id:Copiez l’ID de l’URL dashboard partagé et saisissez-le.
auth > factors: Laissez ce champ vide.

factors > type: Sélectionnez cette option pour obtenir la confirmation en réponse que la valeur du mot de passe est supprimée.

Mutation d'échantillon

mutation {
  dashboardUpdateLiveUrlAuth(
    id: "YOUR_PUBLIC_LINK_UUID"
    auth: { factors: [] } # Send an empty array to remove all authentication
  ) {
    factors {
      # This will be empty
      type
    }
  }
}

Exemple de réponse

Vérifiez que la réponse apparaît comme suit. Le mot de passe est supprimé et l’URL dashboard en direct n’est plus protégée par mot de passe.

{
  "data": {
    "dashboardUpdateLiveUrlAuth": {
      "factors": []
    }
  }
}

Assurez-vous que vous disposez des autorisations nécessaires pour modifier la configuration du dashboard partagé. Pour réinitialiser le mot de passe d’une URL dashboard en direct :

Accédez à l'explorateur d'API NerdGraph.
Construisez un graphe appelé d'API en utilisant la mutation dashboardResetLiveUrlPassword avec les valeurs d'attribut suivantes :

id:Copiez l’ID de l’URL dashboard partagé et saisissez-le.
password: Sélectionnez cette option pour obtenir le nouveau mot de passe dashboard en direct dans la réponse.
Mutation d'échantillon
```
mutation {
  dashboardResetLiveUrlPassword(id: "YOUR_PUBLIC_LINK_UUID") {
    password
  }
}
```
Exemple de réponse
Le nouveau mot de passe apparaît dans la réponse comme suit.
```
{
  "data": {
    "dashboardResetLiveUrlPassword": {
      "password": "system generated password"
    }
  }
}
```
Après avoir réinitialisé le mot de passe du tableau de bord partagé, vous devez partager le nouveau mot de passe avec l'utilisateur. Copiez et enregistrez le mot de passe, car vous ne pourrez pas le récupérer ultérieurement. Si vous le perdez, il vous suffit de le réinitialiser à nouveau. Suivez nos bonnes pratiques de gestion des mots de passe pour gérer le mot de passe en toute sécurité.

En fonction des autorisations dont vous disposez, vous pouvez révoquer uniquement les URL que vous avez créées ou toutes les URL créées par l'utilisateur dans le compte. Pour révoquer une URL dashboard partagée :

Accédez à l'explorateur d'API NerdGraph.
Construisez un graphe appelé d'API en utilisant la mutation dashboardRevokeLiveUrl avec la valeur d'attribut suivante :

id:Copiez l’ID de l’URL dashboard partagé et saisissez-le.
Mutation d'échantillon
```
mutation {
  dashboardRevokeLiveUrl(id: "PUBLIC_LINK_ID") {
    id
  }
}
```
Exemple de réponse
L'URL dashboard partagé est désormais révoquée et ne sera plus accessible. La réponse apparaît comme suit :
```
{
  "data": {
    "dashboardRevokeLiveUrl": {
      "id": "PUBLIC_LINK_ID" //the one you passed to the mutation
    }
  }
}
```

En fonction des autorisations dont vous disposez, vous pouvez récupérer la liste des URL que vous avez créées, ou toutes les URL créées par l'utilisateur du compte. Pour obtenir la liste des URL dashboard partagées :

Accédez à l'explorateur d'API NerdGraph.
Construisez un graphe appelé d'API en utilisant les détails suivants :

actor > dashboard > liveUrls: utilisez ceci pour récupérer la liste des URL dashboard partagées.
filter > type: sélectionnez DASHBOARD pour filtrer les résultats des URL dashboard .

Sélectionnez tous les autres champs que vous souhaitez dans la réponse.

Exemple de requête

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

La liste des URL dashboard partagées apparaît en réponse.

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : créer, mettre à jour et révoquer les URL dashboard de partage public

Prudence

Créer une URL sans protection par mot de passe

Mutation d'échantillon

Exemple de réponse

Important

Créer une URL avec protection par mot de passe

Mutation d'échantillon

Exemple de réponse

Mettre à jour la durée d'expiration dashboard en direct

Mutation d'échantillon

Exemple de réponse

Activer la protection par mot de passe pour l'URL en direct

Mutation d'échantillon

Exemple de réponse

Désactiver la protection par mot de passe pour l'URL en direct

Mutation d'échantillon

Exemple de réponse

Réinitialiser le mot de passe pour l'URL en direct

Mutation d'échantillon

Exemple de réponse

Révoquer une URL active

Mutation d'échantillon

Exemple de réponse

Lister toutes les URL partagées

Exemple de requête