Skip to content
Changelog

Report a bug

Mezmo integration: operations for AI agents

Mezmo connects to Type.com as an integration. This page lists the 220 operations documented for Claude and Codex in Type.com: 103 read, 64 write, 53 destructive.

About Mezmo

Mezmo provides a comprehensive platform for log management and telemetry data processing, enabling organizations to collect, analyze, and manage their log data efficiently.

Categories: Developer Tools & IT

How to connect Mezmo to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

220 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

220 operations listed.

Access Token

  • Read

    Retrieve all access tokens for a user

    Lists the personal access tokens that belong to a user in the account. Without the userid query parameter, the tokens of the requesting user are returned. The secret key of an existing token is never included.

  • Write

    Create access token

    Creates a personal access token for the authenticated user. Tokens can only be created for yourself, not for other users or accounts. Use roles and permissions to control what the token is allowed to do. The token key is only returned once.

  • Write

    Update an access token

    Changes the name of an access token. The key, roles and permissions of an existing token cannot be changed. Create a new token instead. Permissions | Resource | Permission | Usage | | --- | --- | --- | | accesstoken | write | Updates the access token |

  • Destructive

    Remove an access token

    Permanently invalidates an access token. Requests that use the token are rejected immediately. Permissions | Resource | Permission | Usage | | --- | --- | --- | | accesstoken | write | Deletes the access token |

Account

  • Read

    Retrieve all available platform accounts

    Lists the accounts the authenticated user or service account has access to. Only active accounts are returned. A user sees the accounts they are a member of, while an enterprise service account sees every account in its enterprise.

  • Read

    Retrieve a specific platform account

    Retrieves a single account by its identifier. The account must be one the authenticated user or service account has access to, otherwise the response is a 404. Permissions | Resource | Permission | Usage | | --- | --- | --- | | account | read | Reads the account record |

Alerting

  • Read

    Fetch component alert

    Retrieves an alert attached to a pipeline component

  • Read

    List component alerts

    List of alerts attached to a pipeline's components

  • Read

    Retrieves an existing usage threshold alert

    Returns usage threshold configuration

  • Read

    List all threshold alerts

    Returns configuration of existing threshold alerts

  • Write

    Create component alert

    Create an alert attached to a pipeline component

  • Write

    Partially update an existing threshold alert

    Update a part of usage threshold alert

  • Write

    Add usage alert

    Creates a new usage threshold alert configuration

  • Destructive

    Update component alert

    Update an alert attached to a pipeline component

  • Destructive

    Delete component alert

    Removes an alert attached to a pipeline component

  • Destructive

    Update threshold alert

    Replace an existing usage alert with this one

  • Destructive

    Remove usage threshold alert

    Removes an existing threshold alert

Archiving

  • Read

    Get Archive Configuration

    Use this method to get an existing archiving configuration. Permissions | Resource | Permission | Usage | | --- | --- | --- | | archiving | read | Lets you see where your logs are being archived and how they get there |

  • Write

    Create Archive Configuration

    Use this method to configure archiving for an instance. Only one archiving configuration may exist at any time. Permissions | Resource | Permission | Usage | | --- | --- | --- | | archiving | write | Lets you switch archiving on and point it at your own storage bucket |

  • Destructive

    Update Archive Configuration

    Use this method to update an existing archiving configuration. Permissions | Resource | Permission | Usage | | --- | --- | --- | | archiving | write | Lets you move archiving to a different bucket, or refresh its credentials |

  • Destructive

    Delete Archive Configuration

    Use this method to delete the archiving configuration. Permissions | Resource | Permission | Usage | | --- | --- | --- | | archiving | manage | Lets you switch archiving off and clear out the destination settings |

Board

  • Read

    List Boards

    Get a list of boards. Permissions | Resource | Permission | Usage | | --- | --- | --- | | board | read | Lets you see what boards your team has built |

  • Read

    Get Board

    Gets the configuration for a specific board. Permissions | Resource | Permission | Usage | | --- | --- | --- | | board | read | Lets you open a board and look at the graphs on it |

  • Write

    Create Board

    Use this method to create a board. Permissions | Resource | Permission | Usage | | --- | --- | --- | | board | write | Lets you put together a new board of your own |

  • Destructive

    Delete Board

    Use this method to delete a board. Permissions | Resource | Permission | Usage | | --- | --- | --- | | board | manage | Lets you delete a board, which removes it for everyone on the account |

Configuration

  • Read

    List Views

    Get a list of views. Permissions | Resource | Permission | Usage | | --- | --- | --- | | view | read | Lets you see what views your team has saved |

  • Read

    Get View

    Gets the configuration for a specific view. Permissions | Resource | Permission | Usage | | --- | --- | --- | | view | read | Lets you open a view and see its query and whatever alerts are attached |

  • Read

    List Preset Alerts

    Returns all Preset Alerts in the account. Permissions | Resource | Permission | Usage | | --- | --- | --- | | alert | read | Lets you see what preset alerts you can hang off your views |

  • Read

    Get Preset Alert

    Get a specific preset alert Permissions | Resource | Permission | Usage | | --- | --- | --- | | alert | read | Lets you check what a preset alert fires on and where it sends notifications |

  • Read

    List Categories

    Returns all Categories of a type. Permissions | Resource | Permission | Usage | | --- | --- | --- | | category | read | Lets you see what categories your team has set up for this type |

  • Read

    Get Category

    Get a specific category Permissions | Resource | Permission | Usage | | --- | --- | --- | | category | read | Lets you look at a single category and what's filed under it |

  • Write

    Create View

    Use this method to create a view and attach alerts to the view. Permissions | Resource | Permission | Usage | | --- | --- | --- | | view | write | Lets you save a new view and hang alerts off it |

  • Write

    Create Preset Alert

    Use this method to create a preset alert. Permissions | Resource | Permission | Usage | | --- | --- | --- | | alert | write | Lets you set up a reusable alert that any view can share |

  • Write

    Create New Category

    Creates a new category of this type. Permissions | Resource | Permission | Usage | | --- | --- | --- | | category | write | Lets you add a category so things of this type can be filed under it |

  • Destructive

    Update View

    Use this method to update a view. You can change the view configuration details; add or remove view specific alerts; or attach and detach preset alerts.

  • Destructive

    Delete View

    Use this method to delete a view and any attached alerts. Permissions | Resource | Permission | Usage | | --- | --- | --- | | view | manage | Lets you delete a view, taking its attached alerts down with it |

  • Destructive

    Update Alert

    Update a specific preset alert. Permissions | Resource | Permission | Usage | | --- | --- | --- | | alert | write | Lets you retune when an alert fires, or send its notifications somewhere else |

  • Destructive

    Delete Alert

    Use this method to delete a preset alert. Permissions | Resource | Permission | Usage | | --- | --- | --- | | alert | manage | Lets you delete a preset alert, unhooking it from every view using it |

  • Destructive

    Update Category

    Update a specific category. Permissions | Resource | Permission | Usage | | --- | --- | --- | | category | write | Lets you rename a category or change what's filed under it |

  • Destructive

    Delete Category

    Use this method to delete a category. Permissions | Resource | Permission | Usage | | --- | --- | --- | | category | manage | Lets you delete a category, leaving anything filed under it uncategorized |

Data Classification & Profiling

  • Read

    Fetch classifier information

    Retrieve information about a classification of a shared source

  • Read

    Get Field Summary for an analysis

    Get Field Summary for an analysis

  • Read

    Get Field Summary values for a field in an analysis

    Get Field Summary values for a field in an analysis

  • Read

    Fetch usage metrics

    Query and fetch usage metrics from data profiling.

  • Read

    GET /v3/pipeline/{pipelineid}/transform/{pipelinetransformid}/classifier/analysis

    GET /v3/pipeline/{pipeline_id}/transform/{pipeline_transform_id}/classifier/analysis

  • Read

    GET /v3/pipeline/transform/classifier/analysis

    GET /v3/pipeline/transform/classifier/analysis

  • Write

    Update analysis options

    Reset classification and profiling results

Edge Local Deploy

  • Read

    Get client config

    Gets client configuration for Edge pipelines

  • Read

    Fetch logs from Edge

    Receive logs from an Edge pipeline

  • Read

    Poll tasks

    Poll and claim available local deployment tasks for a pipeline

  • Read

    List all heartbeats

    List all Edge check-ins for the account

  • Read

    Get usage metrics

    Receive usage metrics from an Edge pipeline

  • Write

    Post client config

    Posts deployment configuration+liveness for Edge pipelines, returning pipeline config

  • Write

    Add task result

    Add results for a given task

  • Destructive

    Remove heartbeat

    Removes existing Edge heartbeats

Enterprise

  • Read

    Get an Enterprise and its child Accounts

    Get an Enterprise and its child Accounts

  • Read

    Retrieve a specific child account under an enterprise organization

    Retrieve a specific child account under an enterprise organization

  • Read

    Get pipelines for all child organizations of an enterprise

    Get pipelines for all child organizations of an enterprise

  • Read

    Get pipeline health metrics for all child organizations of an enterprise

    Get pipeline health metrics for all child organizations of an enterprise

  • Read

    Get pipeline usage metrics for all child organizations of an enterprise

    Get pipeline usage metrics for all child organizations of an enterprise

  • Read

    Get pipeline node types and schemas

    Get pipeline node types, operators and alert schemas

  • Write

    Create a new Enterprise Child Organization (Account)

    Create a new Enterprise Child Organization (Account)

  • Write

    Perform bulk operations on Enterprise Accounts

    Perform bulk operations (CREATE, UPDATE, DELETE) on Enterprise Accounts

  • Write

    Link Child Account

    Moves an existing individual customer account under the owner ship of an existing enterprise with the option to change its direct owner

  • Write

    Unlink Child Account

    Removes a specific account from under an enterprise making it an independant account. The account will be downgraded to a trial account once the process is complete.

Exclusions

  • Read

    List Exclusion Rules

    Returns a list of exclusion rules. Note: This does not return usage quota rules. Permissions | Resource | Permission | Usage | | --- | --- | --- | | exclusion | read | Lets you see what's being dropped before it ever gets indexed |

  • Read

    Get Exclusion Rule

    Returns an exclusion rule with the id specified. Permissions | Resource | Permission | Usage | | --- | --- | --- | | exclusion | read | Lets you check exactly what a single rule is matching on |

  • Write

    Create Exclusion Rule

    Create a new ingestion exclusion rule to help reduce log volume Permissions | Resource | Permission | Usage | | --- | --- | --- | | exclusion | write | Lets you stop noisy lines being indexed, and counting toward your bill |

  • Write

    Update Exclusion Rule

    Updates an existing exclusion rule Permissions | Resource | Permission | Usage | | --- | --- | --- | | exclusion | write | Lets you adjust what a rule drops when it's catching too much or too little |

  • Destructive

    Delete Exclusion Rule

    Use this method to delete an exclusion rule. Permissions | Resource | Permission | Usage | | --- | --- | --- | | exclusion | manage | Lets you delete a rule, so the lines it was filtering get indexed again |

Export

  • Read

    Export log lines

    Use this method to export logs in JSON format from a logging instance. Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | read | Lets you pull your log lines back out of Mezmo in bulk |

  • Read

    Export log lines

    Use this method to export logs in JSON format from a logging instance. Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | read | Lets you pull your log lines back out of Mezmo in bulk |

Groups

  • Read

    List Groups

    Use this method to list the log groups. Permissions | Resource | Permission | Usage | | --- | --- | --- | | role | read | Lets you see what log groups have been set up on the account |

  • Read

    Get Group

    Use this method to get information on a group. Permissions | Resource | Permission | Usage | | --- | --- | --- | | role | read | Lets you check exactly what data a group's members can reach |

  • Write

    Create Group

    Use this method to create a log group where you can scope the data that is accessible by members in that group. Permissions | Resource | Permission | Usage | | --- | --- | --- | | role | write | Lets you carve out a new group and decide what data its members can reach |

  • Write

    Update Group

    Use this method to modify a log group. You can change the name of the group and the access scope that defines the data that is accessible by members in that group.

  • Destructive

    Delete Group

    Use this method to list the log groups. Permissions | Resource | Permission | Usage | | --- | --- | --- | | role | manage | Lets you delete a group, revoking its data access from everyone assigned to it |

Incident Mode

  • Read

    Fetch state variable

    Fetches the value of a state variable

  • Read

    List all state variables

    List all state variables defined in the account

  • Write

    Create state variable

    Add a pipeline state variable to the account

  • Write

    Partially update state variable

    Update one or many state variables

  • Destructive

    Update state variable

    Edits an existing state variable

Index Rate Alert

  • Read

    Get Index Rate Alert

    Gets the configuration for an Index Rate Alert Permissions | Resource | Permission | Usage | | --- | --- | --- | | indexratealert | read | Lets you see the threshold your account alerts on and who hears about it |

  • Destructive

    Update Index Rate Alert

    Use this method to update an index rate alert. You can change the alert's configuration details. Permissions | Resource | Permission | Usage | | --- | --- | --- | | indexratealert | write | Lets you raise or lower the threshold, and change who gets told when it's crossed |

Ingestion

  • Write

    Send Log Lines

    Use this method to send logs to a logging instance. Authentication You can find instructions on authentication here. Ingestion is similar to the other APIs, but instead of servicekey you will use apikey if you are using the header style authentication.

Investigation

  • Read

    Retrieve a list of AI investigations for the account

    Retrieve a list of AI investigations for the account.

  • Read

    Retrieve a specific AI investigation.

    Retrieve a specific AI investigation by its ID.

Keys

  • Read

    Retrieve a list of all the keys

    Retrieve a list of all the keys for an account. Supported key types include ingestion and service. Use the type parameter to filter which type of keys to retrieve.

  • Read

    Retrieve a specific key

    Retrieves a specific key by its id. Permissions | Resource | Permission | Usage | | --- | --- | --- | | ingestkey | manage | Lets you look up a single key, its value included |

  • Write

    Create a new key

    Create a new key of the type specified by the type parameter. If a name is not supplied, one will be auto generated. Permissions | Resource | Permission | Usage | | --- | --- | --- | | ingestkey | manage | Lets you mint a new ingestion or service key for the account |

  • Destructive

    Update one or more fields of a key resource

    Updates all of the fields described in the request body of the specified key. Fields left out of the body will remain unaffected. Permissions | Resource | Permission | Usage | | --- | --- | --- | | ingestkey | manage | Lets you rename a key or adjust its settings |

  • Destructive

    Delete a specific key

    Delete a specific key by its id. Permissions | Resource | Permission | Usage | | --- | --- | --- | | ingestkey | manage | Lets you revoke a key, which breaks anything still using it immediately |

Log Volume Reduction

  • Write

    Log Volume Reduction

    Post log volume reduction actions to a pipeline

Members

  • Read

    Lists all members

    Retrieves all of the current members in an organization and returns their email, role, and groups. Permissions | Resource | Permission | Usage | | --- | --- | --- | | user | read | Lets you see who's on the team and what role and groups each person has |

  • Read

    Retrieve a member

    Returns the role and groups of the specified member. Permissions | Resource | Permission | Usage | | --- | --- | --- | | user | read | Lets you look up one person's role and group assignments |

  • Write

    Creates a new member

    Create a new user and add to the team by providing 'email', 'role' and an optional list of RBAC groups. Permissions | Resource | Permission | Usage | | --- | --- | --- | | account | manage | Lets you add someone to the org and set their role and groups |

  • Destructive

    Update a member

    Updates all the fields described in the request body of the specified member. Creates a member if the member doesn't exist already. Fields left out of the body will remain unaffected.

  • Destructive

    Delete a member

    Removes a member from the organization. This does not delete the user. Permissions | Resource | Permission | Usage | | --- | --- | --- | | account | manage | Lets you take someone off the team; their user account itself sticks around |

Metrics

  • Read

    Get event metrics for a pipeline

    Query and fetch event metrics for a pipeline

  • Read

    Fetch pipeline health metrics

    Query and fetch health information for the current account.

  • Read

    Fetch account usage metics

    Query and fetch usage metrics for the current account.

  • Read

    Fetch log usage metrics

    Query and fetch log clustering usage metrics from data profiling.

  • Read

    Fetch log cluster samples

    Query and fetch log cluster samples from data profiling.

Parsing Template

  • Read

    List Parsing Templates

    Get a list of custom parsing templates. Permissions | Resource | Permission | Usage | | --- | --- | --- | | customparsing | read | Lets you see what custom parsing your team has set up |

  • Read

    Get Parsing Template

    Gets the configuration for a specific parsing template. Permissions | Resource | Permission | Usage | | --- | --- | --- | | customparsing | read | Lets you look at one template and the fields it pulls out of a line |

  • Destructive

    Delete Parsing Template

    Use this method to delete a parsing template. Permissions | Resource | Permission | Usage | | --- | --- | --- | | customparsing | manage | Lets you delete a template, so new lines stop getting those fields pulled out |

Pipeline

  • Read

    Get account details

    Get list of settings applied to an account

  • Write

    Update account details

    Update account settings

  • Destructive

    Update pipeline processing status

    Change a pipeline to enabled or disabled

Pipeline Export

  • Read

    Export pipeline to manifest

    Export a SaaS pipeline to a portable YAML or JSON manifest. Requires pipeline:read.

  • Write

    Trigger pipeline export

    Prepare a pipeline for export into a terraform workspace.

Pipeline Management

  • Read

    Fetch pipeline confg

    Retrieve a pipeline configuration

  • Read

    List all pipelines

    List all pipelines for the account

  • Read

    Fetch audit events

    Retrieve a paginated list of pipeline audit events for an account

  • Read

    Summarize pipeline health for one or more pipelines

    Returns overall ingestion health as well as pipeline-specific health, such as lag in a pipeline's sources.

  • Read

    List available pipeline nodes

    A list of all available nodes for use when creating pipelines

  • Read

    Fetch pipeline revision

    Returns a pipeline configuration from a particular version

  • Read

    List all pipeline revisions

    Returns a list of revisions that exist in the pipeline

  • Write

    Create pipeline

    Creates a new pipeline (non published)

  • Write

    Inspect a manifest's required secrets

    Inspect a manifest and report the secrets that must be supplied on import. Creates nothing. Requires pipeline:write.

  • Write

    Import a manifest as a new pipeline

    Import a manifest as a new unpublished draft pipeline. Requires pipeline:write.

  • Write

    Add prebuilt pipeline to account

    Creates a new pipeline in the account that is prebuilt

  • Write

    Publish pipeline

    Creates a new pipeline in the account

  • Write

    Revert pipeline to version

    Updates a pipeline configuration to a previous version

  • Write

    Initialize a pipeline with provided components. All sources, transforms, and sinks are linked.

    Populates and publishes a new pipeline as specified.

  • Write

    Initialize a pipeline with provided components. The links for all components have to be determined by the caller.

    Populates and publishes a new pipeline as specified.

  • Destructive

    Update pipeline

    Update pipeline properties, like title

  • Destructive

    Deletes a pipeline

    Removes a pipeline from the account

Pipeline Nodes

  • Read

    Fetch sink

    Fetch a sink configuration of a pipeline

  • Read

    Retrieve source

    Fetches configuration of a source

  • Read

    Fetch transform

    Fetch transform configuration

  • Read

    GET /v3/pipeline/{pipelineid}/transform-group/{pipelinetransformgroupid}

    GET /v3/pipeline/{pipeline_id}/transform-group/{pipeline_transform_group_id}

  • Write

    Add a sink to a pipeline

    POST /v3/pipeline/{pipeline_id}/sink

  • Write

    Add source

    Adds a source to a pipeline

  • Write

    Add transform

    Add a transform to a pipeline

  • Write

    POST /v3/pipeline/{pipelineid}/transform-group

    POST /v3/pipeline/{pipeline_id}/transform-group

  • Destructive

    Update sink

    Updates a sink of a pipeline

  • Destructive

    Delete sink

    Remove sink from a pipeline

  • Destructive

    Update source

    Updates a source in a pipeline

  • Destructive

    Remove source

    Removes a source from a pipeline

  • Destructive

    Update transform

    Updates a transform of a pipeline

  • Destructive

    Remove transform

    Removes transform from pipeline

  • Destructive

    PUT /v3/pipeline/{pipelineid}/transform-group/{pipelinetransformgroupid}

    PUT /v3/pipeline/{pipeline_id}/transform-group/{pipeline_transform_group_id}

  • Destructive

    DELETE /v3/pipeline/{pipelineid}/transform-group/{pipelinetransformgroupid}

    DELETE /v3/pipeline/{pipeline_id}/transform-group/{pipeline_transform_group_id}

Processor Groups

  • Read

    GET /v3/transform-group/{transformgroupid}

    Get a Processor Group

  • Read

    GET /v3/transform-group

    List all Processor Groups for the account

  • Read

    GET /v3/transform-group/{transformgroupid}/revision/{transformgrouprevisionlookup}

    GET /v3/transform-group/{transform_group_id}/revision/{transform_group_revision_lookup}

  • Read

    GET /v3/transform-group/{transformgroupid}/revision

    GET /v3/transform-group/{transform_group_id}/revision

  • Read

    GET /v3/transform-group/{transformgroupid}/transform/{transformgrouptransformid}

    Get a Processor from a Processor Group

  • Write

    POST /v3/transform-group

    Create a new Processor Group

  • Write

    POST /v3/transform-group/{transformgroupid}/publish

    Publish changes to a Processor Group

  • Write

    POST /v3/transform-group/from-pipeline

    Create a new Processor Group from a set of Pipeline components

  • Write

    POST /v3/transform-group/{transformgroupid}/transform

    Create a Processor in a Processor Group

  • Destructive

    PUT /v3/transform-group/{transformgroupid}

    Update a Processor Group

  • Destructive

    DELETE /v3/transform-group/{transformgroupid}

    Delete a Processor Group

  • Destructive

    PUT /v3/transform-group/{transformgroupid}/transform/{transformgrouptransformid}

    Update a Processor in a Processor Group

  • Destructive

    DELETE /v3/transform-group/{transformgroupid}/transform/{transformgrouptransformid}

    Delete a Processor from a Processor Group

Role

  • Read

    Retrieve the set of defined permissions

    Returns every resource that can be granted in a role, a user, a service account or an access token, along with the permission levels (read, write and manage) available for each, a description of what they allow, and any permissions that are implicitly required as a dependency.

  • Read

    Retrieve a list of roles

    Lists the roles available to the account. This includes the roles created by the account along with the shared system roles, such as the built in admin role. Set the system query parameter to false to return only the roles created by the account.

  • Read

    Get a specific role by its identifier

    Retrieves a single role by its identifier. Both roles created by the account and shared system roles can be retrieved. Permissions | Resource | Permission | Usage | | --- | --- | --- | | role | read | Reads the role record |

  • Read

    Retrieve the users assigned to a role

    Lists the users that have been assigned a given role. Permissions | Resource | Permission | Usage | | --- | --- | --- | | user | read | Lists the users holding the role |

  • Write

    Create a new role

    Creates a role for the account. A role is a named set of permissions that can be assigned to users, service accounts and access tokens. A role may inherit the permissions of other roles by listing their identifiers in roles. Permissions are defined by resource in permissions.

  • Destructive

    Update a single role

    Replaces the name, permissions and parent roles of an existing role. The change applies to everyone who holds the role, including users, service accounts and any role that inherits from it. Shared system roles cannot be modified.

  • Destructive

    Delete a role

    Deletes a role created by the account. The role is removed from every user and service account that holds it, and the permissions it granted are revoked. A role that is the parent of another role cannot be deleted.

Sampling and Simulation

  • Read

    Retrieve grok pattern

    Retrieves a list of grok patterns available to use

  • Read

    Fetch data sample

    Returns a data sample

  • Read

    List data samples

    Returns a list of data samples that exist in the pipeline

  • Write

    Simulate grok pattern

    Simulate data flowing through a grok pattern

  • Write

    Simulate regex pattern

    View results of sending data using a regular expression

  • Write

    Start simulation of pipeline

    Sends data to a vector instance with a simulated pipeline

  • Write

    Start pipeline tap

    Start a tap operation to view data as it flows through the pipeline.

  • Write

    Simulate timestamp pattern

    Simulate data with a timestamp format

  • Write

    Create data sample

    Create sample data for use in simulation

  • Write

    POST /v3/transform-group/{transformgroupid}/simulate

    Sends data to a vector instance with a simulated transform group

  • Destructive

    Update data sample

    Updates an existing data sample

  • Destructive

    Delete data sample

    Remove a data sample from the pipeline

Screens

  • Read

    List all screens

    List all screens in a short form that only includes the screen id and title. Permissions | Resource | Permission | Usage | | --- | --- | --- | | screen | read | Lets you see what screens your team has built |

  • Read

    Retrieve a screen

    Retrieve a specific screen Permissions | Resource | Permission | Usage | | --- | --- | --- | | screen | read | Lets you open a screen and see what's on it |

  • Write

    Creates a new screen

    Creates a new screen Permissions | Resource | Permission | Usage | | --- | --- | --- | | screen | write | Lets you put together a new screen of your own |

  • Destructive

    Delete a screen

    Deletes a screen Permissions | Resource | Permission | Usage | | --- | --- | --- | | screen | manage | Lets you delete a screen, which removes it for everyone on the account |

Service Account

  • Read

    Retrieve all service accounts

    Lists the service accounts that belong to the account. A service account is a non-human identity used to authenticate API requests. Set availableforagent to true to return only the service accounts that are not already assigned to an active agent.

  • Read

    Retrieve information about a specific service account

    Retrieves a single service account by its identifier. The access key is never included in the response. Permissions | Resource | Permission | Usage | | --- | --- | --- | | serviceaccount | read | Reads the service account record |

  • Read

    Retrieve the roles assigned to a service account

    Lists the roles assigned to a service account. Permissions | Resource | Permission | Usage | | --- | --- | --- | | role | read | Lists the roles assigned to the service account |

  • Write

    Create a new service account

    Creates a service account for granting access to non-human parties, along with its access key. The key is only returned once. Be sure to store it, as it cannot be retrieved later.

  • Write

    Rotate the access key of a service account

    Rotates the access key associated with a service account. The new access key has the same roles and permissions as its predecessor. It expires according to the expiration configured on the service account, or never if no expiration is configured.

  • Destructive

    Update a service account with new roles and permissions

    Updates the name, description, roles and permissions of a service account. A new access key is not issued. Use the rotate endpoint for that. Permissions | Resource | Permission | Usage | | --- | --- | --- | | serviceaccount | write | Updates the service account |

  • Destructive

    Delete a service account

    Deletes a service account and its associated access key. Access is revoked immediately. Permissions | Resource | Permission | Usage | | --- | --- | --- | | serviceaccount | manage | Deletes the service account and its access key |

Shared Sources

  • Read

    Retrieve gateway route

    Retreive a gateway route

  • Read

    List all gateway routes

    List all of the shareable gateway routes for an account

  • Write

    Update gateway route property

    Patches a gateway route

  • Write

    Create gateway route

    Create a gateway route

  • Write

    Create access key

    Create an access key associated with this gateway route

  • Destructive

    Update gateway route

    Updates a gateway route

  • Destructive

    Delete gateway route

    Delete an unused gateway route. If the route is used by any active pipeline, an error will be returned.

  • Destructive

    Delete access key

    Delete an access key

  • Destructive

    Delete signing key

    Removes a signing key attached to a gateway route

  • Destructive

    Add signing key

    Adds a signing key to a gateway route

Suspensions

  • Read

    Get Ingestion Status

    Retrieve the status of ingestion Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | read | Lets you check whether your account is still taking in log data |

  • Write

    Initiate Ingestion Suspension

    First step in suspending ingestion for the instance. Returns a token for use in /suspend/confirm to actually stop ingestion Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | manage | Lets you start the process of pausing ingestion for the whole account |

  • Write

    Confirm Ingestion Suspension

    After /suspend is called, a token is returned for use with this route as a confirmation. Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | manage | Actually stops ingestion — anything sent while you're suspended is gone for good |

  • Write

    Resume Ingestion

    Resumes ingestion if it has been previously suspended Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | manage | Lets you start taking log data in again after a suspension |

Usage v1

  • Read

    List Usage By App

    Lists aggregated usage information for all apps during a time period. Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | read | Lets you see which apps are using the most of your log volume |

  • Read

    Get Usage By App

    Gets the aggregated usage information for an app matching the name provided as a path parameter, during a time period. Returns null when not found.

  • Read

    List Usage by Tag

    Lists aggregated usage information for all tags during a time period. Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | read | Lets you see which tags are using the most of your log volume |

  • Read

    Get Usage by Tag

    Gets the aggregated usage information for a tag matching the name provided as a path parameter, during a time period. Returns null when not found.

  • Read

    List Usage by Host

    Lists aggregated usage information for all hosts during a time period. Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | read | Lets you see which hosts are using the most of your log volume |

  • Read

    Get Usage by Host

    Gets the aggregated usage information for a host matching the name provided as a path parameter, during a time period. Returns null when not found.

Usage v2

  • Read

    Retrieve account usage totals

    Get aggregated usage information for an account's data during a time period. Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | read | Lets you see how much log volume the account has used over a period |

  • Read

    List Usage By App

    Lists aggregated usage information for all apps during a time period. Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | read | Lets you see which apps are using the most of your log volume |

  • Read

    Get Usage By App

    Gets the aggregated usage information for an app matching the name provided as a path parameter during a time period. The results will either have a singular item, or be an empty array.

  • Read

    List Usage by Host

    Lists aggregated usage information for all hosts during a time period. Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | read | Lets you see which hosts are using the most of your log volume |

  • Read

    Get Usage by Host

    Gets the aggregated usage information for a host matching the name provided as a path parameter during a time period. The results will either have a singular item, or be an empty array.

  • Read

    List Usage by Tag

    Lists aggregated usage information for all tags during a time period. Permissions | Resource | Permission | Usage | | --- | --- | --- | | log | read | Lets you see which tags are using the most of your log volume |

  • Read

    Get Usage by Tag

    Gets the aggregated usage information for a tag matching the name provided as a path parameter during a time period. The results will either have a singular item, or be an empty array.

User

  • Read

    Retrieve a list of users

    Lists the users that are members of the account. Users that have been banned are not included. Permissions | Resource | Permission | Usage | | --- | --- | --- | | user | read | Lists the users in the account |

  • Read

    Retrieve a user

    Retrieves a single member of the account by their identifier or email address. Permissions | Resource | Permission | Usage | | --- | --- | --- | | user | read | Reads the user record |

  • Write

    Create or join a user

    Adds a user to the account. If no user exists for the supplied email, one is created and invited. If the user already exists, they are joined to the account. Roles and permissions can be granted to the user as part of the request.

  • Write

    Modify a user

    Updates a user's profile information along with their roles and permissions. Only the supplied properties are changed. The user can be referenced by identifier or email address. Changing roles or permissions requires additional access.

  • Destructive

    Remove a user from the account

    Removes a user from the account and revokes their roles and permissions. The user can be referenced by identifier or email address. The owner of the account cannot be removed, which results in a 409.

  • Destructive

    Replace the roles assigned to a user

    Replaces the roles assigned to a user. Any role the user currently holds that is not in the request is removed. Optional permissions are applied to the user in addition to the roles.

See How connections work for access and permissions, or browse all integrations.