Command Reference

API Mesh for Adobe Developer App Builder CLI allows you to manage and modify meshes. This page covers commands exclusive to API Mesh. For authorization and other Adobe I/O Extensible CLI commands, refer to the Adobe IO CLI command list. For installation instructions, refer to Getting Started.

aio api-mesh:init

Creates a local development environment. You only need to run this command if you want to set up a local environment.

Usage

aio api-mesh:init PROJECTNAME [-p <value>] [-m npm|yarn] [-g y|n] [--help]
Copied to your clipboard
aio api-mesh:init PROJECTNAME [-p <value>] [-m npm|yarn] [-g y|n] [--help]

Flags

The following arguments are all optional. If you do not supply them, the terminal response will prompt you for the information.

-p or --path allows you to specify the location to set up the local environment.

-g or --git is a binary argument that requires Y or N to determine if you want to use git for your local environment.

-m or --packageManager is a binary argument that requires npm or yarn to determine which package manager to use for the local environment. (Requires npm or yarn.)

--help provides information on the specified command.

Example

The following example creates the environment in the mesh_examples subdirectory of the current directory with git enabled and the package manager set to yarn:

aio api-mesh:init myMesh --path ./mesh_examples --git Y --package-manager yarn
Copied to your clipboard
aio api-mesh:init myMesh --path ./mesh_examples --git Y --package-manager yarn

Response

Local workspace created successfully
Copied to your clipboard
Local workspace created successfully

aio api-mesh:run

Deploys a mesh locally. You only need to run this command if you want to work with your mesh locally for testing. Run aio api-mesh:init before running this command.

Usage

aio api-mesh:run [FILE] [-p <value>] [--debug] [-e <value>] [-c] [--select] [-s <value>] [--help]
Copied to your clipboard
aio api-mesh:run [FILE] [-p <value>] [--debug] [-e <value>] [-c] [--select] [-s <value>] [--help]

Flags

The following arguments are all optional.

-p or --port allows you to specify the port number for your local environment. The default is 5000.

-s or --secrets allows you to specify the path to secrets file.

--select deploys the mesh artifact in the selected workspace without rebuilding it. The select command will not download secrets as artifacts. To use secrets with the --select flag, combine it with the --secrets flag and provide a local file that contains your secrets.

aio api-mesh:run mesh.json --select --secrets secrets.yaml
Copied to your clipboard
aio api-mesh:run mesh.json --select --secrets secrets.yaml

--debug enters debug mode. To debug in an IDE such as Visual Studio Code, add the following configuration to your launch.json file:

{
  "name": "Debug Mesh",
  "port": 9229,
  "request": "attach",
  "skipFiles": ["<node_internals>/**"],
  "type": "node"
}
Copied to your clipboard
{
  "name": "Debug Mesh",
  "port": 9229,
  "request": "attach",
  "skipFiles": ["<node_internals>/**"],
  "type": "node"
}

--help provides information on the specified command.

For more information on debugging, see the node.js Inspector documentation.

Example

The following example runs the mesh locally at port 9000.

aio api-mesh:run mesh.json -p 9000
Copied to your clipboard
aio api-mesh:run mesh.json -p 9000

Response

Starting server on port : 5000
Server is running on http://localhost:5000/graphql
Copied to your clipboard
Starting server on port : 5000
Server is running on http://localhost:5000/graphql

aio api-mesh:create

Creates a new mesh based on the settings in the specified JSON file in your working directory. After creating your mesh, you will receive a meshId, like 12a3b4c5-6d78-4012-3456-7e890fa1bcde, to refer to it in the future. For more information, see Creating a mesh.

You only need to run the create command once. For subsequent changes to your mesh, use the update command.

Usage

aio api-mesh:create [FILE] [-i] [-c] [--json] [-e <value>] [-s <value>] [--help]
Copied to your clipboard
aio api-mesh:create [FILE] [-i] [-c] [--json] [-e <value>] [-s <value>] [--help]

Arguments

FILE The JSON file that contains your mesh's handlers and transforms.

Flags

-i or --ignoreCache ignores the cached organization, project, and workspace, which allows you to create a mesh in a different workspace. You can also manually modify the cache.

-c or --autoConfirmAction automatically confirms the mesh creation instead of prompting the user to confirm.

--json outputs the json of the created mesh.

-e or --env allows you to provide an environment variables file. Refer to developer tools for more information.

--secrets [FILE] allows you to provide a separate YAML file that defines your secrets.

--help provides information on the specified command.

Example

aio api-mesh:create mesh.json
Copied to your clipboard
aio api-mesh:create mesh.json

Response

Your mesh is being provisioned. Wait a few minutes before checking the status of your mesh: 12a3b4c5-6d78-4012-3456-7e890fa1bcde
To check the status of your mesh, run:

aio api-mesh:status
Copied to your clipboard
Your mesh is being provisioned. Wait a few minutes before checking the status of your mesh: 12a3b4c5-6d78-4012-3456-7e890fa1bcde
To check the status of your mesh, run:

aio api-mesh:status

aio api-mesh:update

Updates the mesh for the workspace you select based on the settings specified in the JSON file. For more information, see Updating a mesh.

Usage

aio api-mesh:update [FILE] [-i] [-c] [-e <value>] [-s <value>] [--help]
Copied to your clipboard
aio api-mesh:update [FILE] [-i] [-c] [-e <value>] [-s <value>] [--help]

Arguments

FILE The JSON file that contains your mesh's handlers and transforms.

Flags

-i or --ignoreCache ignores the cached organization, project, and workspace, which allows you to update a mesh in a different workspace. You can also manually modify the cache.

-c or --autoConfirmAction automatically confirms the mesh update instead of prompting the user to confirm.

-e or --env allows you to provide an environment variables file. Refer to developer tools for more information.

-s or --secrets [FILE] allows you to provide a separate YAML file that defines your secrets.

--help provides information on the specified command.

Example

aio api-mesh:update mesh.json
Copied to your clipboard
aio api-mesh:update mesh.json

Response

Your mesh is being provisioned. Wait a few minutes before checking the status of your mesh 12a3b4c5-6d78-4012-3456-7e890fa1bcde
To check the status of your mesh, run:
aio api-mesh:status
Copied to your clipboard
Your mesh is being provisioned. Wait a few minutes before checking the status of your mesh 12a3b4c5-6d78-4012-3456-7e890fa1bcde
To check the status of your mesh, run:
aio api-mesh:status

aio api-mesh:status

Retrieves the current status of your create or update command.

If your mesh is taking too long to build, consider using local development.

Example

aio api-mesh:status
Copied to your clipboard
aio api-mesh:status

Response

Four possible responses reflect the status of your mesh:

Success - Your mesh was successfully created or updated.

Legacy Mesh Status: 
Your mesh was successfully built.
*********************************
Edge Mesh Status:
Your mesh was successfully built.
Copied to your clipboard
Legacy Mesh Status: 
Your mesh was successfully built.
*********************************
Edge Mesh Status:
Your mesh was successfully built.

Pending - Your mesh is queued and awaiting processing.

Pending: Your mesh is awaiting processing.
Copied to your clipboard
Pending: Your mesh is awaiting processing.

Building - Our servers are currently processing your mesh.

Pending: Your mesh is currently being provisioned. Wait a few minutes before checking again.
Copied to your clipboard
Pending: Your mesh is currently being provisioned. Wait a few minutes before checking again.

Error - Your mesh encountered an error.

Unable to get the mesh status. If the error persists please contact support. RequestId: 1234567890
Copied to your clipboard
Unable to get the mesh status. If the error persists please contact support. RequestId: 1234567890

Since this command describes the status of both the legacy and edge mesh builds, any failures or errors that appear in the Legacy Mesh Status, will subsequently affect the edge mesh. This means you must resolve any errors in your legacy mesh build before using the edge mesh URL.

aio api-mesh:get

Retrieves the current JSON mesh file for the workspace you select. Any secrets you defined when creating the mesh are not included in the response.

Usage

aio api-mesh:get [FILE] [-i] [--json] [--help]
Copied to your clipboard
aio api-mesh:get [FILE] [-i] [--json] [--help]

Arguments

DOWNLOAD (Optional) specify the local filename to create from the mesh.

Flags

-i or --ignoreCache ignores the cached organization, project, and workspace, which allows you to retrieve a mesh from a different workspace. You can also manually modify the cache.

--json outputs the file as JSON.

--help provides information on the specified command.

Example

aio api-mesh:get
Copied to your clipboard
aio api-mesh:get

Response

Successfully retrieved mesh {
  "lastUpdated": "2022-06-01T12:12:12.0000",
  "meshConfig": {
    "sources": [
      {
        "name": "Commerce",
        "handler": {
          "graphql": {
            "endpoint": "https://<your_commerce_site>/graphql/"
          }
        }
      },
      {
        "name": "AEM",
        "handler": {
          "graphql": {
            "endpoint": "https://<your_AEM_site>/endpoint.json"
          }
        }
      },
      {
        "name": "LiveSearch",
        "handler": {
          "graphql": {
            "endpoint": "https://<your_commerce_site>/search/graphql",
            "operationHeaders": {
              "Magento-Store-View-Code": "default",
              "Magento-Website-Code": "base",
              "Magento-Store-Code": "main_website_store",
              "Magento-Environment-Id": "<your_environment_id>",
              "x-api-key": "search_gql",
              "Content-Type": "application/json"
            },
            "schemaHeaders": {
              "Magento-Store-View-Code": "default",
              "Magento-Website-Code": "base",
              "Magento-Store-Code": "main_website_store",
              "Magento-Environment-Id": "<your_environment_id>",
              "x-api-key": "search_gql",
              "Content-Type": "application/json"
            }
          }
        }
      }
    ]
  },
  "meshId": "12a3b4c5-6d78-4012-3456-7e890fa1bcde",
  "lastUpdatedBy": {
    "firstName": "User",
    "lastName": "Name",
    "userEmail": "uname@domain.com",
    "userId": "A4BF2F3C61FC531A0A494210@AdobeID",
    "displayName": "User%20Name"
  },
  "meshStatus": "success",
}
Copied to your clipboard
Successfully retrieved mesh {
  "lastUpdated": "2022-06-01T12:12:12.0000",
  "meshConfig": {
    "sources": [
      {
        "name": "Commerce",
        "handler": {
          "graphql": {
            "endpoint": "https://<your_commerce_site>/graphql/"
          }
        }
      },
      {
        "name": "AEM",
        "handler": {
          "graphql": {
            "endpoint": "https://<your_AEM_site>/endpoint.json"
          }
        }
      },
      {
        "name": "LiveSearch",
        "handler": {
          "graphql": {
            "endpoint": "https://<your_commerce_site>/search/graphql",
            "operationHeaders": {
              "Magento-Store-View-Code": "default",
              "Magento-Website-Code": "base",
              "Magento-Store-Code": "main_website_store",
              "Magento-Environment-Id": "<your_environment_id>",
              "x-api-key": "search_gql",
              "Content-Type": "application/json"
            },
            "schemaHeaders": {
              "Magento-Store-View-Code": "default",
              "Magento-Website-Code": "base",
              "Magento-Store-Code": "main_website_store",
              "Magento-Environment-Id": "<your_environment_id>",
              "x-api-key": "search_gql",
              "Content-Type": "application/json"
            }
          }
        }
      }
    ]
  },
  "meshId": "12a3b4c5-6d78-4012-3456-7e890fa1bcde",
  "lastUpdatedBy": {
    "firstName": "User",
    "lastName": "Name",
    "userEmail": "uname@domain.com",
    "userId": "A4BF2F3C61FC531A0A494210@AdobeID",
    "displayName": "User%20Name"
  },
  "meshStatus": "success",
}

aio api-mesh:delete

Deletes the mesh from the selected workspace.

Usage

aio api-mesh:delete [-i] [-c] [--help]
Copied to your clipboard
aio api-mesh:delete [-i] [-c] [--help]

Flags

-i or --ignoreCache ignores the cached organization, project, and workspace, which allows you to delete a mesh from a different workspace. You can also manually modify the cache.

-c or --autoConfirmAction automatically confirms the mesh deletion instead of prompting the user to confirm.

--help provides information on the specified command.

Example

aio api-mesh:delete
Copied to your clipboard
aio api-mesh:delete

Response

Successfully deleted 12a3b4c5-6d78-4012-3456-7e890fa1bcde
Copied to your clipboard
Successfully deleted 12a3b4c5-6d78-4012-3456-7e890fa1bcde

aio api-mesh:describe

Describes the mesh for the selected workspace. The description includes legacy and edge mesh endpoints.

Usage

aio api-mesh:describe [-i] [--help]
Copied to your clipboard
aio api-mesh:describe [-i] [--help]

Flags

-i or--ignoreCache ignores the cached organization, project, and workspace, which allows you to get the description of a different workspace. You can also manually modify the cache.

--help provides information on the specified command

Response

Selected organization: my-org
Selected project: test-project
Select workspace: Stage
Successfully retrieved mesh details 

Org ID: 123456789
Project ID: 1234567890123456789
Workspace ID: 2345678901234567890
Mesh ID: 12a3b4c5-6d78-4012-3456-7e890fa1bcde
Legacy Mesh Endpoint: https://graph.adobe.io/api/123456-123-456-789-1234567890/graphql?api_key=09876543210987654321
Edge Mesh Endpoint: https://edge-graph.adobe.io/api/123456-123-456-789-1234567890/graphql
Copied to your clipboard
Selected organization: my-org
Selected project: test-project
Select workspace: Stage
Successfully retrieved mesh details 

Org ID: 123456789
Project ID: 1234567890123456789
Workspace ID: 2345678901234567890
Mesh ID: 12a3b4c5-6d78-4012-3456-7e890fa1bcde
Legacy Mesh Endpoint: https://graph.adobe.io/api/123456-123-456-789-1234567890/graphql?api_key=09876543210987654321
Edge Mesh Endpoint: https://edge-graph.adobe.io/api/123456-123-456-789-1234567890/graphql

aio api-mesh:source:discover

Lists all available sources. Select a source to view its configuration file and copy its content to your clipboard. You can also view available sources directly in the api-mesh-sources repository.

Sources are prebuilt mesh configuration files that are formatted for a specific combination of handlers. Each source contains a mesh configuration file designed for a specific first or third-party source. Third parties can submit their sources as a pull request to the api-mesh-sources repository. See Create a mesh from a source for more information.

Usage

aio api-mesh:source:discover [--help]
Copied to your clipboard
aio api-mesh:source:discover [--help]

Flags

--help provides information on the specified command.

Response

[
  {
      "name": "Adobe Commerce Compare List",
      "version": "0.0.2",
      "description": "Source to get information about Compare list",
      "author": "Adobe team",
      "provider": {
          "name": "Commerce",
          "handler": {
            "graphql": {
              "endpoint": "https://venia.magento.com/graphql/"
            }
          },
          "transforms": [
            {
              "rename": {
                "mode": "bare | wrap",
                "renames": [
                  {
                    "from": {
                      "type": "Query",
                      "field": "compareList"
                    },
                    "to": {
                      "type": "Query",
                      "field": "productCompareList"
                    }
                  }
                ]
              }
            },
            {
              "filterSchema": {
                "mode": "bare | wrap",
                "filters": [
                  "Query.!category",
                  "Query.!customerOrders",
                  "Query.!urlResolver",
                  "Query.!wishlist"
                ]
              }
            },
          ]
        }
  }
]
Copied to your clipboard
[
  {
      "name": "Adobe Commerce Compare List",
      "version": "0.0.2",
      "description": "Source to get information about Compare list",
      "author": "Adobe team",
      "provider": {
          "name": "Commerce",
          "handler": {
            "graphql": {
              "endpoint": "https://venia.magento.com/graphql/"
            }
          },
          "transforms": [
            {
              "rename": {
                "mode": "bare | wrap",
                "renames": [
                  {
                    "from": {
                      "type": "Query",
                      "field": "compareList"
                    },
                    "to": {
                      "type": "Query",
                      "field": "productCompareList"
                    }
                  }
                ]
              }
            },
            {
              "filterSchema": {
                "mode": "bare | wrap",
                "filters": [
                  "Query.!category",
                  "Query.!customerOrders",
                  "Query.!urlResolver",
                  "Query.!wishlist"
                ]
              }
            },
          ]
        }
  }
]

aio api-mesh:source:get

Prints the specified source's mesh file and allows you to copy it to the clipboard.

Usage

aio api-mesh:source:get [-s <value>] [-m] [--help]
Copied to your clipboard
aio api-mesh:source:get [-s <value>] [-m] [--help]

Flags

-s or --source (required) allows you to specify the name of the source you want to copy. -m or --multiple allows you to add multiple sources, which are returned in an array. --help provides information on the specified command.

Example

aio api-mesh:source:get -s "AEM Assets API"
Copied to your clipboard
aio api-mesh:source:get -s "AEM Assets API"

With multiple sources:

aio api-mesh:source:get -m -s "AEM Assets API" -s "Adobe Target API"
Copied to your clipboard
aio api-mesh:source:get -m -s "AEM Assets API" -s "Adobe Target API"

Response

[
  {
      "name": "AEM Assets API",
      "version": "0.0.2",
      "description": "A source for the AEM Assets API",
      "author": "Adobe team",
      "provider": {
          "name": "Commerce",
          "handler": {
            "graphql": {
              "endpoint": "https://venia.magento.com/graphql/"
            }
          },
          "transforms": [
            {
              "rename": {
                "mode": "bare | wrap",
                "renames": [
                  {
                    "from": {
                      "type": "Query",
                      "field": "compareList"
                    },
                    "to": {
                      "type": "Query",
                      "field": "productCompareList"
                    }
                  }
                ]
              }
            },
            {
              "filterSchema": {
                "mode": "bare | wrap",
                "filters": [
                  "Query.!category",
                  "Query.!customerOrders",
                  "Query.!urlResolver",
                  "Query.!wishlist"
                ]
              }
            },
            {
              "cache": [
                {
                  "field": "Query.storeConfig",
                  "invalidate": {
                    "ttl": 3600
                  }
                }
              ]
            }
          ]
        }
  }
]
Copied to your clipboard
[
  {
      "name": "AEM Assets API",
      "version": "0.0.2",
      "description": "A source for the AEM Assets API",
      "author": "Adobe team",
      "provider": {
          "name": "Commerce",
          "handler": {
            "graphql": {
              "endpoint": "https://venia.magento.com/graphql/"
            }
          },
          "transforms": [
            {
              "rename": {
                "mode": "bare | wrap",
                "renames": [
                  {
                    "from": {
                      "type": "Query",
                      "field": "compareList"
                    },
                    "to": {
                      "type": "Query",
                      "field": "productCompareList"
                    }
                  }
                ]
              }
            },
            {
              "filterSchema": {
                "mode": "bare | wrap",
                "filters": [
                  "Query.!category",
                  "Query.!customerOrders",
                  "Query.!urlResolver",
                  "Query.!wishlist"
                ]
              }
            },
            {
              "cache": [
                {
                  "field": "Query.storeConfig",
                  "invalidate": {
                    "ttl": 3600
                  }
                }
              ]
            }
          ]
        }
  }
]

aio api-mesh:source:install

The install command adds the specified source to the currently selected workspace's mesh configuration.

Usage

aio api-mesh:source:install "<source_name>"
Copied to your clipboard
aio api-mesh:source:install "<source_name>"

To install a specific version of a source, use the following command:

aio api-mesh:source:install [SOURCE] [-v <value>] [-f <value>] [-i] [--help]
Copied to your clipboard
aio api-mesh:source:install [SOURCE] [-v <value>] [-f <value>] [-i] [--help]

The two variable flags, -v and -f, described in the following section, allow you to automatically replace any of the variables defined in the source that you are installing with your values.

When using the -f or --variable-file flag, you must specify the variables in a separate file. The following example defines the variable file formatting:

{
"ENDPOINT_URL": "https://venia.magento.com/graphql"
}
Copied to your clipboard
{
"ENDPOINT_URL": "https://venia.magento.com/graphql"
}

Flags

-v or --variable specifies the values of any variables defined in the variables array of the mesh configuration file for the source. Use commas to separate multiple variables.

-f or --variable-file specifies a file location that contains variables to use in the mesh configuration file for the source. The file must be in .json format.

-i or --ignoreCache ignores the cached organization, project, and workspace, which allows you to install a source in a different workspace.

--help provides information on the specified command.

Example

aio api-mesh:source:install "AEM Assets API"
Copied to your clipboard
aio api-mesh:source:install "AEM Assets API"

With a variable:

aio api-mesh:source:install "AEM Assets API" -v ENDPOINT_URL:https://venia.magento.com/graphql
Copied to your clipboard
aio api-mesh:source:install "AEM Assets API" -v ENDPOINT_URL:https://venia.magento.com/graphql

With a variable file:

aio api-mesh:source:install "AEM Assets API" -f documents/my_variables.json
Copied to your clipboard
aio api-mesh:source:install "AEM Assets API" -f documents/my_variables.json

Install a specific version:

aio api-mesh:source:install "AEM Assets API"@0.0.1
Copied to your clipboard
aio api-mesh:source:install "AEM Assets API"@0.0.1

Response

Successfully updated the mesh with the id: MESH_ID
Copied to your clipboard
Successfully updated the mesh with the id: MESH_ID

aio api-mesh:log-list

The log-list command lists the most recent requests for your mesh by rayID. By default, the command shows the 15 most recent requests.

Usage

aio api-mesh:log-list [-i] [--filename <value>] [--help]
Copied to your clipboard
aio api-mesh:log-list [-i] [--filename <value>] [--help]

Flags

The following arguments are optional:

--filename allows you to download a CSV list of rayIDs with the specified filename. This flag exports all requests from the last 15 minutes.

-i or --ignoreCache ignores the cached organization, project, and workspace, which allows you to make new selections. You can also manually modify the cache.

--help provides information on the specified command.

Response

Selected organization: <ORG_NAME>
Selected project: <PROJECT_NAME>
Select workspace: <WORKSPACE_NAME>
 Ray id           Timestamp      Response status Level          
 ──────────────── ────────────── ─────────────── ────────────── 
 1a123456789abcd1 1724766278577  200             log            
 1a123456789abcd2 1724766287188  200             log            
 1a123456789abcd3 1724766286997  200             log            
 1a123456789abcd4 1724766280810  200             error
Copied to your clipboard
Selected organization: <ORG_NAME>
Selected project: <PROJECT_NAME>
Select workspace: <WORKSPACE_NAME>
 Ray id           Timestamp      Response status Level          
 ──────────────── ────────────── ─────────────── ────────────── 
 1a123456789abcd1 1724766278577  200             log            
 1a123456789abcd2 1724766287188  200             log            
 1a123456789abcd3 1724766286997  200             log            
 1a123456789abcd4 1724766280810  200             error

aio api-mesh:log-get

After finding the desired rayID with the aio api-mesh:log-list command, you can use the following command to retrieve the logs for a specific rayID:

Usage

aio api-mesh:log-get RAYID [-i] [--help]
Copied to your clipboard
aio api-mesh:log-get RAYID [-i] [--help]

Flags

The following arguments are optional.

-i or --ignoreCache ignores the cached organization, project, and workspace, which allows you to make new selections. You can also manually modify the cache.

--help provides information on the specified command.

Example

The following example gets the log for the 1a123456789abcd0 rayID:

aio api-mesh:log-get 1a123456789abcd0
Copied to your clipboard
aio api-mesh:log-get 1a123456789abcd0

Response

EventTimestampMs : 1724660422500
Exceptions : []
Logs : [{'Level': 'log', 'Message': ['[object Object]'], 'TimestampMs': 1724660422580}, {'Level': 'log', 'Message': ['{"sources":[{"name":"venia","handler":{"graphql":{"useGETForQueries":true,"endpoint":"https://venia.magento.com/graphql","operationHeaders":{"x-test-header":"{context.headers[\'x-test-header\']}"}}}}],"responseConfig":{"includeHTTPDetails":true},"additionalResolvers":[],"plugins":[{"httpDetailsExtensions":{}}]}'], 'TimestampMs': 1724660422500}]
Outcome : ok
MeshId : 12a3b4c5-6d78-4012-3456-7e890fa1bcde
RayId : 1a123456789abcd0
MeshUrl : https://edge-graph.adobe.io/api/REDACTED/graphql
RequestMethod : POST
RequestStatus : 200 
Copied to your clipboard
EventTimestampMs : 1724660422500
Exceptions : []
Logs : [{'Level': 'log', 'Message': ['[object Object]'], 'TimestampMs': 1724660422580}, {'Level': 'log', 'Message': ['{"sources":[{"name":"venia","handler":{"graphql":{"useGETForQueries":true,"endpoint":"https://venia.magento.com/graphql","operationHeaders":{"x-test-header":"{context.headers[\'x-test-header\']}"}}}}],"responseConfig":{"includeHTTPDetails":true},"additionalResolvers":[],"plugins":[{"httpDetailsExtensions":{}}]}'], 'TimestampMs': 1724660422500}]
Outcome : ok
MeshId : 12a3b4c5-6d78-4012-3456-7e890fa1bcde
RayId : 1a123456789abcd0
MeshUrl : https://edge-graph.adobe.io/api/REDACTED/graphql
RequestMethod : POST
RequestStatus : 200

aio api-mesh:log-get-bulk

The log-get-bulk command creates a CSV file with logs for the selected mesh during the specified time range. The maximum time range is 30 minutes and only logs from the last 30 days are accessible.

Usage

aio api-mesh:log-get-bulk [--startTime <value>] [--endTime <value>] [--filename <value>] [-i] [--help]
Copied to your clipboard
aio api-mesh:log-get-bulk [--startTime <value>] [--endTime <value>] [--filename <value>] [-i] [--help]

Flags

The following arguments are required:

--startTime the start time for log collection in the format YYYY-MM-DDTHH:MM:SSZ. You must convert your local time to UTC.

--endTime the end time for log collection in the format YYYY-MM-DDTHH:MM:SSZ. You must convert your local time to UTC.

--filename specifies the name of the file to output the logs to.

The following arguments are optional:

-i or --ignoreCache ignores the cached organization, project, and workspace, which allows you to make new selections. You can also manually modify the cache.

--help provides information on the specified command.

Example

The following example bulk downloads logs as a file named mesh_logs.csv for the specified time range:

aio api-mesh:log-get-bulk --startTime 2024-08-27T21:31:39Z --endTime 2024-08-27T21:55:54Z --filename mesh_logs.csv
Copied to your clipboard
aio api-mesh:log-get-bulk --startTime 2024-08-27T21:31:39Z --endTime 2024-08-27T21:55:54Z --filename mesh_logs.csv

Response

Expected file size is 500 KB. Confirm mesh_logs.csv download? (y/n)`
...
Successfully downloaded the logs to mesh_logs.csv.
Copied to your clipboard
Expected file size is 500 KB. Confirm mesh_logs.csv download? (y/n)`
...
Successfully downloaded the logs to mesh_logs.csv.

The downloaded file will look similar to this example.

Next steps

Type merging

Local development

Last updated 9/26/2024

Was this helpful?

Yes

Command Reference

aio api-mesh:init.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Usage.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Flags

Example

Response

aio api-mesh:run

Usage

Flags

Example

Response

aio api-mesh:create

Usage

Arguments

Flags

Example

Response

aio api-mesh:update

Usage

Arguments

Flags

Example

Response

aio api-mesh:status

Example

Response

aio api-mesh:get

Usage

Arguments

Flags

Example

Response

aio api-mesh:delete

Usage

Flags

Example

Response

aio api-mesh:describe

Usage

Flags

Response

aio api-mesh:source:discover

Usage

Flags

Response

aio api-mesh:source:get

Usage

Flags

Example

Response

aio api-mesh:source:install

Usage

Flags

Example

Response

aio api-mesh:log-list

Usage

Flags

Response

aio api-mesh:log-get

Usage

Flags

Example

Response

aio api-mesh:log-get-bulk

Usage

Flags

Example

Response

Next steps

aio api-mesh:init

Usage