--- updatedAt: 2026-05-26T21:25:49.000Z agentTools: projectIndex: https://docs.socket.dev/llms.txt --- # Create API Token Create an API Token. The API Token created must use a subset of permissions the API token creating them. This endpoint consumes 10 units of your quota. This endpoint requires the following org token scopes: - api-tokens:create # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "description": "Specification of the Socket API endpoints", "title": "API Endpoints", "version": "0" }, "servers": [ { "url": "https://api.socket.dev/v0" } ], "tags": [ { "name": "api-tokens" } ], "components": { "responses": { "SocketUnauthorized": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "", "properties": { "error": { "type": "object", "additionalProperties": true, "description": "", "properties": { "message": { "type": "string", "description": "", "default": "" }, "details": { "type": "object", "additionalProperties": true, "description": "", "default": null, "nullable": true } }, "required": [ "details", "message" ] } }, "required": [ "error" ] } } }, "description": "Unauthorized" }, "SocketForbidden": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "", "properties": { "error": { "type": "object", "additionalProperties": true, "description": "", "properties": { "message": { "type": "string", "description": "", "default": "" }, "details": { "type": "object", "additionalProperties": true, "description": "", "default": null, "nullable": true } }, "required": [ "details", "message" ] } }, "required": [ "error" ] } } }, "description": "Insufficient max_quota for API method" }, "SocketTooManyRequestsResponse": { "description": "Insufficient quota for API route", "headers": { "Retry-After": { "description": "Retry contacting the endpoint *at least* after seconds.\nSee https://tools.ietf.org/html/rfc7231#section-7.1.3", "schema": { "format": "int32", "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "", "properties": { "error": { "type": "object", "additionalProperties": true, "description": "", "properties": { "message": { "type": "string", "description": "", "default": "" }, "details": { "type": "object", "additionalProperties": true, "description": "", "default": null, "nullable": true } }, "required": [ "details", "message" ] } }, "required": [ "error" ] } } } }, "SocketNotFoundResponse": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "", "properties": { "error": { "type": "object", "additionalProperties": true, "description": "", "properties": { "message": { "type": "string", "description": "", "default": "" }, "details": { "type": "object", "additionalProperties": true, "description": "", "default": null, "nullable": true } }, "required": [ "details", "message" ] } }, "required": [ "error" ] } } }, "description": "Resource not found" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Organization Tokens can be passed as a Bearer token" }, "basicAuth": { "type": "http", "scheme": "basic", "description": "Organization Tokens can be passed as the user field in basic auth" } } }, "paths": { "/orgs/{org_slug}/api-tokens": { "post": { "tags": [ "api-tokens" ], "summary": "Create API Token", "operationId": "postAPIToken", "parameters": [ { "name": "org_slug", "in": "path", "required": true, "description": "The slug of the organization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "max_quota": { "type": "integer", "description": "Maximum number of API calls allowed per month", "default": 1000 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "alerts", "alerts:list", "alerts:trend", "socket-firewall-deployment", "socket-firewall-deployment:update", "alert-policy", "alert-policy:list", "alert-policy:read", "alert-policy:create", "alert-policy:update", "alert-policy:delete", "alert-resolution", "alert-resolution:list", "alert-resolution:create", "alert-resolution:read", "alert-resolution:delete", "threat-campaigns", "threat-campaigns:list", "api-tokens", "api-tokens:create", "api-tokens:update", "api-tokens:revoke", "api-tokens:rotate", "api-tokens:list", "audit-log", "audit-log:list", "dependencies", "dependencies:list", "dependencies:trend", "fixes", "fixes:list", "full-scans", "full-scans:list", "full-scans:create", "full-scans:delete", "diff-scans", "diff-scans:list", "diff-scans:create", "diff-scans:delete", "entitlements", "entitlements:list", "historical", "historical:snapshots-list", "historical:snapshots-start", "historical:alerts-list", "historical:alerts-trend", "historical:dependencies-list", "historical:dependencies-trend", "integration", "integration:list", "integration:create", "integration:update", "integration:delete", "access-policy", "access-policy:read", "access-policy:attach", "access-policy:update", "license-policy", "license-policy:update", "license-policy:read", "packages", "packages:list", "access-policy-definition", "access-policy-definition:attach", "access-policy-definition:read", "access-policy-definition:update", "report", "report:list", "report:read", "report:write", "repo", "repo:list", "repo:create", "repo:update", "repo:delete", "repo-label", "repo-label:list", "repo-label:create", "repo-label:update", "repo-label:delete", "security-policy", "security-policy:update", "security-policy:read", "socket-basics", "socket-basics:read", "telemetry-policy", "telemetry-policy:update", "telemetry-events", "telemetry-events:list", "threat-feed", "threat-feed:list", "triage", "triage:alerts-list", "triage:alerts-update", "uploaded-artifacts", "uploaded-artifacts:create", "uploaded-artifacts:list", "vulnerability-feed", "vulnerability-feed:list", "webhooks", "webhooks:create", "webhooks:list", "webhooks:update", "webhooks:delete", "openid", "profile", "email", "selected-organization", "*" ], "description": "The scope of permissions for this API Token", "default": "repo:list" }, "description": "List of scopes granted to the API Token" }, "visibility": { "type": "string", "enum": [ "admin", "organization" ], "description": "The visibility of the API Token. Warning: this field is deprecated and will be removed in the future.", "default": "organization" }, "committer": { "type": "object", "additionalProperties": false, "properties": { "email": { "type": "string", "description": "Email address of the committer", "default": "" }, "provider": { "type": "string", "enum": [ "api", "azure", "bitbucket", "github", "gitlab" ], "description": "The source control provider for the committer", "default": "api" }, "providerLoginName": { "type": "string", "description": "Login name on the provider platform", "default": "" }, "providerUserId": { "type": "string", "description": "User ID on the provider platform", "default": "" } }, "description": "Committer information to associate with the API Token" }, "name": { "type": "string", "description": "Name for the API Token", "default": "api token" }, "resources": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "organizationSlug": { "type": "string", "description": "Slug of the organization to grant access to", "default": "" }, "repositorySlug": { "type": "string", "description": "Slug of the repository to grant access to", "default": "" }, "workspace": { "type": "string", "description": "Workspace slug containing the specified repo", "default": "" } }, "required": [ "organizationSlug", "repositorySlug" ] }, "description": "List of resources this API Token can access. Tokens with resource grants can only access a subset of routes that support this feature." } }, "required": [ "committer", "max_quota", "scopes", "visibility" ] } } }, "description": "The settings to create the api token with.", "required": false }, "security": [ { "bearerAuth": [ "api-tokens:create" ] }, { "basicAuth": [ "api-tokens:create" ] } ], "description": "Create an API Token. The API Token created must use a subset of permissions the API token creating them.\n\nThis endpoint consumes 10 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- api-tokens:create", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "", "properties": { "created_by": { "type": "string", "description": "ID of the Socket user who created the API Token", "default": "", "format": "uuid", "nullable": true }, "group_uuid": { "type": "string", "description": "The stable group UUID that remains constant across token rotations", "default": "", "format": "uuid" }, "token": { "type": "string", "description": "", "default": "" }, "hash": { "type": "string", "description": "", "default": "" } }, "required": [ "created_by", "group_uuid", "hash", "token" ] } } }, "description": "The newly created api token with its stable UUID and hash." }, "401": { "$ref": "#/components/responses/SocketUnauthorized" }, "403": { "$ref": "#/components/responses/SocketForbidden" }, "404": { "$ref": "#/components/responses/SocketNotFoundResponse" }, "429": { "$ref": "#/components/responses/SocketTooManyRequestsResponse" } }, "x-readme": {} } } } } ```