Home / Directory / Apollo GraphOS / CreateApiKey

CreateApiKey

An MCP tool from the Apollo GraphOS server, run by Apollo.

Create an API key for an organization. The response contains the new key's value in token. It is a live credential, so give it to the user to store in a secret manager, and do not repeat it, log it, or pass it to another tool. Which key types you can create depends on how you authenticate. With the GraphOS sign-in (OAuth), you can create OPERATOR, SCIM, and GATEWAY keys. SUBGRAPH and VARIANT keys need a personal API key in the x-api-key header. With an operator key in x-api-key, you can create only GATEWAY keys, and a graph key can create none. No credential can create ROUTER keys. OPERATOR, SCIM, and GATEWAY keys also require the Org Admin role. GATEWAY keys are used by Apollo Gateway instances. Choose the narrowest type that does the job, and confirm the type and its resources with the user before you call this tool. Provide the organization ID, the key name, and the type. For a SUBGRAPH key, list each graphId, variantName, and subgraphName in resources.subgraphs. For a VARIANT key, list each graphId and va

Name on the gateway: apollo_graphos__CreateApiKey.

Parameters

NameTypeDescription
organizationId requiredstring
name requiredstring
type requiredany
resourcesmixed

How to call it

Through the Smart Gateway, any client can run it by name with call_tool, or let the gateway find it with search_tools:

call_tool arguments
{
  "name": "apollo_graphos__CreateApiKey",
  "arguments": {
    "organizationId": "…",
    "name": "…",
    "type": "…"
  }
}

The first call connects Apollo GraphOS to your account automatically; nothing to set up. About this server.

Try asking

Use the createapikey tool with organizationId set to ….

More from Apollo GraphOS