Graze API EndPoint Reference

This is a reference list for the Graze API endpoints. Follow the links to see the details of each endpoint.

All Graze API requests, other than authenticate, require a basic authentication header or a valid auth_token. You must make a valid authenticate request before using any Graze API request without a basic authentication header. See Authentication for more information.

Alerts

The following Graze API endpoints relate to alerts:

Algorithms

Use the following Graze API endpoints to configure Cookbooks and Recipes:

Use the following Graze API endpoints to configure Tempus:

Use the following Graze API endpoints to update the default merge group:

Use the following Graze API endpoints to configure custom merge groups:

Dashboards and reporting

See the Stats API for information on Graze API endpoints that provide statistics related to dashboards or reporting.

Entropy thresholds and Events Analyser configuration

Processes and maintenance

The following Graze API endpoints relate to Moogsoft Enterprise processes and scheduled maintenance:

Situations

The following Graze API endpoints relate to Situations:

Security realms

The following Graze API endpoints relate to security realms:

  • createSecurityRealm: Creates a new security realm from an Identity Provider (IdP) URL.

  • getSecurityRealm: Returns a JSON object containing the names and configuration details of active security realms.

  • updateSecurityRealm: Updates an existing security realm in the database.

Topologies

See Topologies API Endpoint Reference for a list of endpoints related to topologies.

User management

The following Graze API endpoints relate to the management of users, teams and roles:

  • applyNewLicense: Adds a Moogsoft Enterprise license via Graze.

  • createTeam: Creates a new team.

  • createUser: Creates a new user.

  • deleteTeam: Deletes a single team.

  • getAllSessionInfo: Returns session information for all users over a period of time.

  • getTeam: Returns a team's details by team ID or name.

  • getTeams: Returns the details of all the teams in Moogsoft Enterprise.

  • getTeamsForService: Returns all teams related to the service with the specified ID or name.

  • getTeamSituationIds: Returns the total number of Situations that are assigned to a team, and a list of their Situation IDs.

  • getUserInfo: Returns information about a user.

  • getUserRoles: Returns the user's roles from the database.

  • getUsers: Returns a list of all users in the database.

  • getUserSessionInfo: Returns session information for a single user over a period of time.

  • getUserTeams: Returns the team names and IDs associated with a user ID or username.

  • updateTeam: Updates an existing team.

  • updateUser: Updates an existing user.

Workflow Engine

The following Graze API endpoints relate to the Workflow Engine:

  • createWorkflow: Creates a new workflow in the Workflow Engine.

  • deleteWorkflow: Deletes a workflow from the Workflow Engine.

  • getWorkflowEngineMoolets: Returns a list of all the workflows in all the Workflow Engine Moolets in Moogsoft Enterprise.

  • getWorkflows: Returns workflows for a specified Workflow Engine Moolet.

  • reorderWorkflows: Reorders the sequence of workflows within a Workflow Engine Moolet.

  • sendToWorkflow: Sends a Moolet Inform message to a workflow in an Inform Workflow Engine.

  • updateWorkflow: Updates an existing workflow in the Workflow Engine.