The duration in milliseconds where each request is counted. Once the maxRequests is reached, the request will be rejected until the timeWindow has passed, at which point the timeWindow will be reset. server-only. Eg: 1000
Maximum amount of requests allowed within a window. Once the maxRequests is reached, the request will be rejected until the timeWindow has passed, at which point the timeWindow will be reset. server-only. Eg: 100
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Attaxr","description":"Documentation for Attaxr products, including Aquila, the event-driven reconnaissance platform.","colors":{"primary":"#A65C20","light":"#C87E49","dark":"#8F4E1B"},"logo":{"light":"https://mintcdn.com/attaxr/MHalKSj-bN0GdJYy/images/logo/light.png?fit=max\u0026auto=format\u0026n=MHalKSj-bN0GdJYy\u0026q=85\u0026s=abf97baa6a60e8d7a6a937900f6edd29","dark":"https://mintcdn.com/attaxr/MHalKSj-bN0GdJYy/images/logo/dark.png?fit=max\u0026auto=format\u0026n=MHalKSj-bN0GdJYy\u0026q=85\u0026s=6512f52a1d4bcd0fc2f5a23329924c0b","href":"https://attaxr.com"},"favicon":"https://mintcdn.com/attaxr/WmVWyjSdkfM5S7Cg/images/favicon-32x32.png?fit=max\u0026auto=format\u0026n=WmVWyjSdkfM5S7Cg\u0026q=85\u0026s=497dbda2ed53d22b159fce8577aeb912","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"]}},"appearance":{"default":"dark"},"background":{"decoration":"gradient","color":{"light":"#FFFFFF","dark":"#161619"}},"fonts":{"heading":{"family":"Archivo"},"body":{"family":"Figtree"}},"icons":{"library":"tabler"},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"one-dark-pro"}},"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"attaxr","hasAudioNarration":false,"actualSubdomain":"attaxr","customDomains":["docs.attaxr.com"],"gitSource":{"type":"github","owner":"attaxr","repo":"ai-recon-system","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ac5835c79a4c3012f99b069","collectionId":"714bfde1-0ed3-4707-9163-1d64a501b974","liveDeploymentHistoryId":"6ac5835c79a4c3012f99b069","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ac5835c79a4c3012f99b069","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Aquila","count":226},{"language":"default","tag":"API endpoints","count":200},{"language":"default","tag":"Auth","count":35},{"language":"default","tag":"Platform","count":11},{"language":"default","tag":"Reports","count":11},{"language":"default","tag":"Chat","count":10},{"language":"default","tag":"Leads","count":10},{"language":"default","tag":"OOB","count":9},{"language":"default","tag":"Workspace","count":9},{"language":"default","tag":"Vulnerabilities","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":":root{--aquila-amber:#a65c20;--aquila-amber-bright:#c87e49;--aquila-amber-deep:#8f4e1b;--aquila-canvas-dark:#161619;--aquila-card-dark:#18181b}h1,h2{font-variation-settings:\"wdth\" 104}::-webkit-scrollbar{width:6px;height:6px}::-webkit-scrollbar-track{background:0 0}::-webkit-scrollbar-thumb{background:rgba(128,128,128,.35);border-radius:3px}::-webkit-scrollbar-thumb:hover{background:rgba(128,128,128,.6)}:not(pre)>code{border-radius:4px}.sidebar-content .sidebar-item[data-active=true],html.dark .sidebar-content .sidebar-item[data-active=true]{color:var(--aquila-amber-bright)}html.dark img.tab-icon[src*=\"/images/agents/\"]{filter:invert(1)}html.dark .code-block-background,html.dark .code-block-root,html.dark [data-component-part=code-block-root]{--shiki-dark-bg:var(--aquila-card-dark)!important;background-color:var(--aquila-card-dark)!important}.openapi-method-badge{border-radius:4px}"}],"page":{"pagePath":"api-reference/auth/create-a-new-api-key-for-a-user","slug":"/api-reference/auth/create-a-new-api-key-for-a-user","pageMetadata":{"title":"Create a new API key for a user","description":"Create a new API key for a user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/api-key/create","href":"/api-reference/auth/create-a-new-api-key-for-a-user","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a new API key for a user\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"one-dark-pro"}},"config":{},"pageMetadata":{"title":"Create a new API key for a user","description":"Create a new API key for a user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/api-key/create","href":"/api-reference/auth/create-a-new-api-key-for-a-user","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Auth"],"description":"Create a new API key for a user","security":["e8ce8267-a3b4-400b-9663-c2b0e4ca3b2e"],"parameters":[],"requestBody":"49c707c5-bbdf-4dc5-b273-e57db4137977","responses":{"200":"d422609d-3355-424d-8f75-00746a2925d5","400":"978b24fd-f247-45c5-ac49-613528abf006","401":"88c4ea23-8dac-42ec-b8c5-ec433193b796","403":"341d426b-f2ec-4e79-9978-886bfa7f26a2","404":"c94ee904-d835-4cd5-bd1b-2a25d7a48996","429":"9add3857-7bfd-43d3-9aa1-4d9df2387cdb","500":"34a2a6f2-4995-426e-9c42-365b3e6fdbf5"},"summary":"Create a new API key for a user","method":"post","type":"path","servers":["32b3e00b-d838-4cae-b045-f5ba869973b9","7fba9cca-7b65-4140-9749-9a7e365463bb"],"path":"/api/auth/api-key/create","baseUrlOptions":["https://aquila.attaxr.com","http://localhost"],"title":"Create a new API key for a user","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"configId":{"type":"string","description":"The configuration ID to use for the API key. If not provided, the default configuration will be used.","uniqueKey":"configId","typeLabel":"string"},"name":{"type":"string","description":"Name of the Api Key","uniqueKey":"name","typeLabel":"string"},"expiresIn":{"oneOf":[{"type":"number","description":"Expiration time of the Api Key in seconds","uniqueKey":"expiresIn.oneOf.0","typeLabel":"number"},{"type":"null","description":"Expiration time of the Api Key in seconds","uniqueKey":"expiresIn.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiresIn","typeLabel":"number | null"},"prefix":{"type":"string","description":"Prefix of the Api Key","uniqueKey":"prefix","typeLabel":"string"},"remaining":{"oneOf":[{"type":"number","description":"Remaining number of requests. Server side only","uniqueKey":"remaining.oneOf.0","typeLabel":"number"},{"type":"null","description":"Remaining number of requests. Server side only","uniqueKey":"remaining.oneOf.1","typeLabel":"null"}],"uniqueKey":"remaining","typeLabel":"number | null"},"metadata":{"oneOf":[{}],"uniqueKey":"metadata","typeLabel":"any"},"refillAmount":{"type":"number","description":"Amount to refill the remaining count of the Api Key. server-only. Eg: 100","uniqueKey":"refillAmount","typeLabel":"number"},"refillInterval":{"type":"number","description":"Interval to refill the Api Key in milliseconds. server-only. Eg: 1000","uniqueKey":"refillInterval","typeLabel":"number"},"rateLimitTimeWindow":{"type":"number","description":"The duration in milliseconds where each request is counted. Once the `maxRequests` is reached, the request will be rejected until the `timeWindow` has passed, at which point the `timeWindow` will be reset. server-only. Eg: 1000","uniqueKey":"rateLimitTimeWindow","typeLabel":"number"},"rateLimitMax":{"type":"number","description":"Maximum amount of requests allowed within a window. Once the `maxRequests` is reached, the request will be rejected until the `timeWindow` has passed, at which point the `timeWindow` will be reset. server-only. Eg: 100","uniqueKey":"rateLimitMax","typeLabel":"number"},"rateLimitEnabled":{"type":"boolean","description":"Whether the key has rate limiting enabled. server-only. Eg: true","uniqueKey":"rateLimitEnabled","typeLabel":"boolean"},"permissions":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"permissions.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"permissions.additionalProperties","typeLabel":"string[]"},"description":"Permissions of the Api Key.","uniqueKey":"permissions","typeLabel":"object"},"userId":{"type":"string","description":"User Id of the user that the Api Key belongs to. server-only. Eg: \"user-id\"","uniqueKey":"userId","typeLabel":"string"},"organizationId":{"type":"string","description":"Organization Id of the organization that the Api Key belongs to. Eg: 'org-id'","uniqueKey":"organizationId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"configId":"\u003cstring>","name":"\u003cstring>","expiresIn":123,"prefix":"\u003cstring>","remaining":123,"metadata":"\u003cunknown>","refillAmount":123,"refillInterval":123,"rateLimitTimeWindow":123,"rateLimitMax":123,"rateLimitEnabled":true,"permissions":{},"userId":"\u003cstring>","organizationId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"d422609d-3355-424d-8f75-00746a2925d5":{"description":"API key created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the API key","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"key":{"type":"string","description":"The full API key (only returned on creation)","isRequired":true,"uniqueKey":"key","typeLabel":"string"},"enabled":{"type":"boolean","description":"Whether the key is enabled","isRequired":true,"uniqueKey":"enabled","typeLabel":"boolean"},"referenceId":{"type":"string","description":"ID of the reference owning the key","isRequired":true,"uniqueKey":"referenceId","typeLabel":"string"},"rateLimitEnabled":{"type":"boolean","description":"Whether rate limiting is enabled","isRequired":true,"uniqueKey":"rateLimitEnabled","typeLabel":"boolean"},"requestCount":{"type":"number","description":"Current request count in window","isRequired":true,"uniqueKey":"requestCount","typeLabel":"number"},"name":{"oneOf":[{"type":"string","description":"Name of the API key","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the API key","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"prefix":{"oneOf":[{"type":"string","description":"Prefix of the API key","uniqueKey":"prefix.oneOf.0","typeLabel":"string"},{"type":"null","description":"Prefix of the API key","uniqueKey":"prefix.oneOf.1","typeLabel":"null"}],"uniqueKey":"prefix","typeLabel":"string | null"},"start":{"oneOf":[{"type":"string","description":"Starting characters of the key (if configured)","uniqueKey":"start.oneOf.0","typeLabel":"string"},{"type":"null","description":"Starting characters of the key (if configured)","uniqueKey":"start.oneOf.1","typeLabel":"null"}],"uniqueKey":"start","typeLabel":"string | null"},"expiresAt":{"oneOf":[{"type":"string","format":"date-time","description":"Expiration timestamp","uniqueKey":"expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Expiration timestamp","uniqueKey":"expiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiresAt","typeLabel":"string\u003cdate-time> | null"},"lastRefillAt":{"oneOf":[{"type":"string","format":"date-time","description":"Last refill timestamp","uniqueKey":"lastRefillAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Last refill timestamp","uniqueKey":"lastRefillAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastRefillAt","typeLabel":"string\u003cdate-time> | null"},"lastRequest":{"oneOf":[{"type":"string","format":"date-time","description":"Last request timestamp","uniqueKey":"lastRequest.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Last request timestamp","uniqueKey":"lastRequest.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastRequest","typeLabel":"string\u003cdate-time> | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Metadata associated with the key","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Metadata associated with the key","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"rateLimitMax":{"oneOf":[{"type":"number","description":"Maximum requests in time window","uniqueKey":"rateLimitMax.oneOf.0","typeLabel":"number"},{"type":"null","description":"Maximum requests in time window","uniqueKey":"rateLimitMax.oneOf.1","typeLabel":"null"}],"uniqueKey":"rateLimitMax","typeLabel":"number | null"},"rateLimitTimeWindow":{"oneOf":[{"type":"number","description":"Rate limit time window in milliseconds","uniqueKey":"rateLimitTimeWindow.oneOf.0","typeLabel":"number"},{"type":"null","description":"Rate limit time window in milliseconds","uniqueKey":"rateLimitTimeWindow.oneOf.1","typeLabel":"null"}],"uniqueKey":"rateLimitTimeWindow","typeLabel":"number | null"},"remaining":{"oneOf":[{"type":"number","description":"Remaining requests","uniqueKey":"remaining.oneOf.0","typeLabel":"number"},{"type":"null","description":"Remaining requests","uniqueKey":"remaining.oneOf.1","typeLabel":"null"}],"uniqueKey":"remaining","typeLabel":"number | null"},"refillAmount":{"oneOf":[{"type":"number","description":"Amount to refill","uniqueKey":"refillAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Amount to refill","uniqueKey":"refillAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"refillAmount","typeLabel":"number | null"},"refillInterval":{"oneOf":[{"type":"number","description":"Refill interval in milliseconds","uniqueKey":"refillInterval.oneOf.0","typeLabel":"number"},{"type":"null","description":"Refill interval in milliseconds","uniqueKey":"refillInterval.oneOf.1","typeLabel":"null"}],"uniqueKey":"refillInterval","typeLabel":"number | null"},"permissions":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"permissions.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"permissions.oneOf.0.additionalProperties","typeLabel":"string[]"},"description":"Permissions associated with the key","uniqueKey":"permissions.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"permissions.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"permissions.oneOf.1.additionalProperties","typeLabel":"string[]"},"description":"Permissions associated with the key","uniqueKey":"permissions.oneOf.1","typeLabel":"null"}],"uniqueKey":"permissions","typeLabel":"object | null"}},"required":["id","createdAt","updatedAt","key","enabled","referenceId","rateLimitEnabled","requestCount"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","key":"\u003cstring>","enabled":true,"referenceId":"\u003cstring>","rateLimitEnabled":true,"requestCount":123,"name":"\u003cstring>","prefix":"\u003cstring>","start":"\u003cstring>","expiresAt":"2023-11-07T05:31:56Z","lastRefillAt":"2023-11-07T05:31:56Z","lastRequest":"2023-11-07T05:31:56Z","metadata":{},"rateLimitMax":123,"rateLimitTimeWindow":123,"remaining":123,"refillAmount":123,"refillInterval":123,"permissions":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"978b24fd-f247-45c5-ac49-613528abf006":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Bad Request. Usually due to missing parameters, or invalid parameters.","exampleType":"generated"},"88c4ea23-8dac-42ec-b8c5-ec433193b796":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Unauthorized. Due to missing or invalid authentication.","exampleType":"generated"},"341d426b-f2ec-4e79-9978-886bfa7f26a2":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Forbidden. You do not have permission to access this resource or to perform this action.","exampleType":"generated"},"c94ee904-d835-4cd5-bd1b-2a25d7a48996":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Not Found. The requested resource was not found.","exampleType":"generated"},"9add3857-7bfd-43d3-9aa1-4d9df2387cdb":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Too Many Requests. You have exceeded the rate limit. Try again later.","exampleType":"generated"},"34a2a6f2-4995-426e-9c42-365b3e6fdbf5":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Internal Server Error. This is a problem with the server that you cannot fix.","exampleType":"generated"}},"security":{"e8ce8267-a3b4-400b-9663-c2b0e4ca3b2e":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Personal API key sent as a bearer token.","scopes":[]}}},"servers":{"32b3e00b-d838-4cae-b045-f5ba869973b9":{"url":"https://aquila.attaxr.com"},"7fba9cca-7b65-4140-9749-9a7e365463bb":{"url":"http://localhost"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Personal API key sent as a bearer token.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Personal API key sent as a bearer token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api/openapi.json"},"subdomain":"attaxr","siteName":"Attaxr","title":"Create a new API key for a user - Attaxr","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-04T07:53:48.711Z","originalFileLocation":"api-reference/auth/create-a-new-api-key-for-a-user.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a new API key for a user\">\u003cmeta data-mint-head name=\"application-name\" content=\"Attaxr\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/attaxr/DLStylfAkRYF1TQj/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/attaxr/DLStylfAkRYF1TQj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/attaxr/DLStylfAkRYF1TQj/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/attaxr/DLStylfAkRYF1TQj/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/attaxr/DLStylfAkRYF1TQj/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/attaxr/DLStylfAkRYF1TQj/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/attaxr/DLStylfAkRYF1TQj/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/attaxr/DLStylfAkRYF1TQj/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/attaxr/DLStylfAkRYF1TQj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a new API key for a user - Attaxr\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new API key for a user\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Attaxr\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.attaxr.com/api-reference/auth/create-a-new-api-key-for-a-user\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://attaxr.mintlify.app/_mintlify/api/og/v2?division=Auth\u0026amp;title=Create+a+new+API+key+for+a+user\u0026amp;description=Create+a+new+API+key+for+a+user\u0026amp;theme=b243938877b80a01a133e3aa\u0026amp;signature=de60dd170d28de1b8ec17fbbf024f7069f801d7c1df9e65f622c932fcdf04e0c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a new API key for a user - Attaxr\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new API key for a user\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://attaxr.mintlify.app/_mintlify/api/og/v2?division=Auth\u0026amp;title=Create+a+new+API+key+for+a+user\u0026amp;description=Create+a+new+API+key+for+a+user\u0026amp;theme=b243938877b80a01a133e3aa\u0026amp;signature=de60dd170d28de1b8ec17fbbf024f7069f801d7c1df9e65f622c932fcdf04e0c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/attaxr/DLStylfAkRYF1TQj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Attaxr\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#A65C20\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.attaxr.com/api-reference/auth/create-a-new-api-key-for-a-user\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/auth/create-a-new-api-key-for-a-user.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.attaxr.com/#organization\",\"name\":\"Attaxr\",\"url\":\"https://docs.attaxr.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/attaxr/MHalKSj-bN0GdJYy/images/logo/light.png?fit=max\u0026auto=format\u0026n=MHalKSj-bN0GdJYy\u0026q=85\u0026s=abf97baa6a60e8d7a6a937900f6edd29\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.attaxr.com#website\",\"name\":\"Attaxr\",\"url\":\"https://docs.attaxr.com\",\"publisher\":{\"@id\":\"https://docs.attaxr.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.attaxr.com/api-reference/auth/create-a-new-api-key-for-a-user#webpage\",\"url\":\"https://docs.attaxr.com/api-reference/auth/create-a-new-api-key-for-a-user\",\"name\":\"Create a new API key for a user\",\"description\":\"Create a new API key for a user\",\"dateModified\":\"2026-10-04T07:53:48.711Z\",\"isPartOf\":{\"@id\":\"https://docs.attaxr.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.attaxr.com/api-reference/auth/create-a-new-api-key-for-a-user#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.attaxr.com/api-reference/auth/create-a-new-api-key-for-a-user#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API endpoints\",\"item\":\"https://docs.attaxr.com/api-reference/agents/list-agent-sessions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Auth\",\"item\":\"https://docs.attaxr.com/api-reference/auth/get-the-account-info-provided-by-the-provider\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a new API key for a user\",\"item\":\"https://docs.attaxr.com/api-reference/auth/create-a-new-api-key-for-a-user\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.attaxr.com/api-reference/auth/create-a-new-api-key-for-a-user#apireference\",\"headline\":\"Create a new API key for a user\",\"name\":\"Create a new API key for a user\",\"description\":\"Create a new API key for a user\",\"url\":\"https://docs.attaxr.com/api-reference/auth/create-a-new-api-key-for-a-user\",\"mainEntityOfPage\":{\"@id\":\"https://docs.attaxr.com/api-reference/auth/create-a-new-api-key-for-a-user#webpage\"},\"dateModified\":\"2026-10-04T07:53:48.711Z\",\"publisher\":{\"@id\":\"https://docs.attaxr.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.attaxr.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Attaxr\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Attaxr","nav":{"global":null,"products":[{"product":"Aquila","icon":"https://mintlify.s3.us-west-1.amazonaws.com/attaxr/images/aquila-mark.png","description":"Event-driven reconnaissance platform.","groups":[{"group":"Start here","pages":[{"title":"Introduction","href":""},{"title":"Quickstart","href":"/quickstart"},{"title":"Authentication","href":"/authentication"},{"title":"Rate limits","href":"/rate-limits"},{"title":"Errors","href":"/errors"},{"title":"Pagination","href":"/pagination"}]},{"group":"MCP server setup","pages":[{"title":"MCP overview","href":"/mcp/overview"},{"title":"Connect a coding agent","href":"/mcp/setup"}]},{"group":"Platform","pages":[{"title":"Scans","href":"/guides/scans"},{"title":"Schedules","href":"/guides/schedules"},{"title":"Workflows","href":"/guides/workflows"},{"title":"Agents","href":"/guides/agents"},{"title":"Hackbot","href":"/guides/hackbot"},{"title":"Workspace","href":"/guides/workspace"},{"title":"Classification","href":"/guides/classification"},{"title":"Leads","href":"/guides/leads"},{"title":"Vulnerabilities","href":"/guides/vulnerabilities"},{"title":"Reports","href":"/guides/reports"},{"title":"Reinforcements","href":"/guides/reinforcements"}]},{"group":"Surface monitoring","pages":[{"title":"Out-of-band (OOB)","href":"/guides/oob"},{"title":"JavaScript monitoring","href":"/guides/js-monitoring"},{"title":"Shares","href":"/guides/shares"}]},{"group":"Settings surfaces","pages":[{"title":"AI providers (BYOK)","href":"/guides/provider-keys"},{"title":"Notifications","href":"/guides/notifications"}]},{"group":"Reference","pages":[{"title":null,"href":"/reference/uncover-providers"}]},{"group":"API reference","pages":[{"title":"API reference","href":"/api/overview"}]},{"group":"API endpoints","pages":[{"group":"Agents","pages":[{"title":"List agent sessions","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/agents","href":"/api-reference/agents/list-agent-sessions"},{"title":"Delete agent runs","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/agents/bulk-delete","href":"/api-reference/agents/delete-agent-runs"},{"title":"Stop agent runs","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/agents/stop","href":"/api-reference/agents/stop-agent-runs"},{"title":"Get an agent session","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/agents/{id}","href":"/api-reference/agents/get-an-agent-session"},{"title":"Delete an agent session","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/agents/{id}","href":"/api-reference/agents/delete-an-agent-session"},{"title":"Get agent session events","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/agents/{id}/events","href":"/api-reference/agents/get-agent-session-events"}]},{"group":"AI","pages":[{"title":"Generate an agent config (WebSocket)","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/ai/generate-agent-config","href":"/api-reference/ai/generate-an-agent-config-websocket"},{"title":"Generate an agent prompt (WebSocket)","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/ai/generate-agent-prompt","href":"/api-reference/ai/generate-an-agent-prompt-websocket"},{"title":"Generate scan goals (stream)","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/ai/generate-goals","href":"/api-reference/ai/generate-scan-goals-stream"},{"title":"Generate a plan (stream)","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/ai/generate-plan","href":"/api-reference/ai/generate-a-plan-stream"},{"title":"Generate skills (WebSocket)","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/ai/generate-skills","href":"/api-reference/ai/generate-skills-websocket"},{"title":"Generate a workflow plan (stream)","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/ai/generate-workflow-plan","href":"/api-reference/ai/generate-a-workflow-plan-stream"}]},{"group":"Auth","pages":[{"title":"Get the account info provided by the provider","description":"Get the account info provided by the provider","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/auth/account-info","href":"/api-reference/auth/get-the-account-info-provided-by-the-provider"},{"title":"Create a new API key for a user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/api-key/create","href":"/api-reference/auth/create-a-new-api-key-for-a-user"},{"title":"Delete an existing API key","description":"Delete an existing API key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/api-key/delete","href":"/api-reference/auth/delete-an-existing-api-key"},{"title":"Retrieve an existing API key by ID","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/auth/api-key/get","href":"/api-reference/auth/retrieve-an-existing-api-key-by-id"},{"title":"List all API keys for the authenticated user or for a specific organization","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/auth/api-key/list","href":"/api-reference/auth/list-all-api-keys-for-the-authenticated-user-or-for-a-specific-organization"},{"title":"Update an existing API key by ID","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/api-key/update","href":"/api-reference/auth/update-an-existing-api-key-by-id"},{"title":"Change the password of the user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/change-password","href":"/api-reference/auth/change-the-password-of-the-user"},{"title":"Delete the user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/delete-user","href":"/api-reference/auth/delete-the-user"},{"title":"Callback to complete user deletion with verification token","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/auth/delete-user/callback","href":"/api-reference/auth/callback-to-complete-user-deletion-with-verification-token"},{"title":"Displays an error page","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/auth/error","href":"/api-reference/auth/displays-an-error-page"},{"title":"Get a valid access token, doing a refresh if needed","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/get-access-token","href":"/api-reference/auth/get-a-valid-access-token-doing-a-refresh-if-needed"},{"title":"Get the current session","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/auth/get-session","href":"/api-reference/auth/get-the-current-session"},{"title":"Get the current session","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/get-session","href":"/api-reference/auth/get-the-current-session-1"},{"title":"Link a social account to the user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/link-social","href":"/api-reference/auth/link-a-social-account-to-the-user"},{"title":"List all accounts linked to the user","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/auth/list-accounts","href":"/api-reference/auth/list-all-accounts-linked-to-the-user"},{"title":"List all active sessions for the user","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/auth/list-sessions","href":"/api-reference/auth/list-all-active-sessions-for-the-user"},{"title":"Check if the API is working","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/auth/ok","href":"/api-reference/auth/check-if-the-api-is-working"},{"title":"Refresh the access token using a refresh token","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/refresh-token","href":"/api-reference/auth/refresh-the-access-token-using-a-refresh-token"},{"title":"Send a password reset email to the user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/request-password-reset","href":"/api-reference/auth/send-a-password-reset-email-to-the-user"},{"title":"Reset the password for a user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/reset-password","href":"/api-reference/auth/reset-the-password-for-a-user"},{"title":"Redirects the user to the callback URL with the token","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/auth/reset-password/{token}","href":"/api-reference/auth/redirects-the-user-to-the-callback-url-with-the-token"},{"title":"Revoke all other sessions for the user except the current one","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/revoke-other-sessions","href":"/api-reference/auth/revoke-all-other-sessions-for-the-user-except-the-current-one"},{"title":"Revoke a single session","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/revoke-session","href":"/api-reference/auth/revoke-a-single-session"},{"title":"Revoke all sessions for the user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/revoke-sessions","href":"/api-reference/auth/revoke-all-sessions-for-the-user"},{"title":"Send a verification email to the user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/send-verification-email","href":"/api-reference/auth/send-a-verification-email-to-the-user"},{"title":"Sign in with email and password","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/sign-in/email","href":"/api-reference/auth/sign-in-with-email-and-password"},{"title":"Sign in with a social provider","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/sign-in/social","href":"/api-reference/auth/sign-in-with-a-social-provider"},{"title":"Sign in with username","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/sign-in/username","href":"/api-reference/auth/sign-in-with-username"},{"title":"Sign out the current user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/sign-out","href":"/api-reference/auth/sign-out-the-current-user"},{"title":"Sign up a user using email and password","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/sign-up/email","href":"/api-reference/auth/sign-up-a-user-using-email-and-password"},{"title":"Unlink an account","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/unlink-account","href":"/api-reference/auth/unlink-an-account"},{"title":"Update the current session","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/update-session","href":"/api-reference/auth/update-the-current-session"},{"title":"Update the current user","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/update-user","href":"/api-reference/auth/update-the-current-user"},{"title":"Verify the email of the user","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/auth/verify-email","href":"/api-reference/auth/verify-the-email-of-the-user"},{"title":"Verify the current user's password","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/auth/verify-password","href":"/api-reference/auth/verify-the-current-users-password"}]},{"group":"Budget","pages":[{"title":"Get AI usage and budget","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/budget","href":"/api-reference/budget/get-ai-usage-and-budget"},{"title":"Save one budget entry","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/budget","href":"/api-reference/budget/save-one-budget-entry"},{"title":"Get provider-side plan quota","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/budget/provider-quota","href":"/api-reference/budget/get-provider-side-plan-quota"}]},{"group":"Bulk Delete","pages":[{"title":"Enqueue a bulk delete","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/bulk-delete","href":"/api-reference/bulk-delete/enqueue-a-bulk-delete"},{"title":"Get bulk-delete job status","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/bulk-delete/{jobId}","href":"/api-reference/bulk-delete/get-bulk-delete-job-status"}]},{"group":"Chat","pages":[{"title":"List chat threads","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/chat","href":"/api-reference/chat/list-chat-threads"},{"title":"Create a chat thread","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/chat","href":"/api-reference/chat/create-a-chat-thread"},{"title":"List chat capabilities","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/chat/capabilities","href":"/api-reference/chat/list-chat-capabilities"},{"title":"Get a thread","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/chat/{id}","href":"/api-reference/chat/get-a-thread"},{"title":"Delete a thread","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/chat/{id}","href":"/api-reference/chat/delete-a-thread"},{"title":"Rename or update a thread","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /api/chat/{id}","href":"/api-reference/chat/rename-or-update-a-thread"},{"title":"Approve a pending action","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/chat/{id}/approve","href":"/api-reference/chat/approve-a-pending-action"},{"title":"Set or update the session goal","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/chat/{id}/goal","href":"/api-reference/chat/set-or-update-the-session-goal"},{"title":"Append a message","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/chat/{id}/messages","href":"/api-reference/chat/append-a-message"},{"title":"Steer the running turn","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/chat/{id}/steer","href":"/api-reference/chat/steer-the-running-turn"}]},{"group":"Constraints","pages":[{"title":"List resources","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/constraints","href":"/api-reference/constraints/list-resources"},{"title":"Create a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/constraints","href":"/api-reference/constraints/create-a-resource"},{"title":"Get a resource by id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/constraints/{id}","href":"/api-reference/constraints/get-a-resource-by-id"},{"title":"Update a resource (partial)","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/constraints/{id}","href":"/api-reference/constraints/update-a-resource-partial"},{"title":"Delete a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/constraints/{id}","href":"/api-reference/constraints/delete-a-resource"}]},{"group":"Dashboard","pages":[{"title":"Get the attack-surface radar data","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/dashboard/attack-surface","href":"/api-reference/dashboard/get-the-attack-surface-radar-data"},{"title":"Get dashboard counters","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/dashboard/counts","href":"/api-reference/dashboard/get-dashboard-counters"}]},{"group":"Events","pages":[{"title":"List resources","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/events","href":"/api-reference/events/list-resources"},{"title":"Create a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/events","href":"/api-reference/events/create-a-resource"},{"title":"Clear all events","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/events","href":"/api-reference/events/clear-all-events"},{"title":"Get a resource by id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/events/{id}","href":"/api-reference/events/get-a-resource-by-id"},{"title":"Update a resource (partial)","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/events/{id}","href":"/api-reference/events/update-a-resource-partial"},{"title":"Delete a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/events/{id}","href":"/api-reference/events/delete-a-resource"}]},{"group":"JS Analysis","pages":[{"title":"List JavaScript analyses","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/js-analysis","href":"/api-reference/js-analysis/list-javascript-analyses"},{"title":"Get an analysis","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/js-analysis/{id}","href":"/api-reference/js-analysis/get-an-analysis"},{"title":"Delete an analysis","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/js-analysis/{id}","href":"/api-reference/js-analysis/delete-an-analysis"},{"title":"Queue a new analysis run","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/js-analysis/{id}/run","href":"/api-reference/js-analysis/queue-a-new-analysis-run"},{"title":"Get the active share link","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/js-analysis/{id}/share","href":"/api-reference/js-analysis/get-the-active-share-link"},{"title":"Create a share link","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/js-analysis/{id}/share","href":"/api-reference/js-analysis/create-a-share-link"},{"title":"Revoke the share link","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/js-analysis/{id}/share","href":"/api-reference/js-analysis/revoke-the-share-link"}]},{"group":"JS Monitoring","pages":[{"title":"List JavaScript monitors","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/js-monitoring","href":"/api-reference/js-monitoring/list-javascript-monitors"},{"title":"Create or reuse a monitor","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/js-monitoring","href":"/api-reference/js-monitoring/create-or-reuse-a-monitor"},{"title":"Get a monitor","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/js-monitoring/{id}","href":"/api-reference/js-monitoring/get-a-monitor"},{"title":"Delete a monitor","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/js-monitoring/{id}","href":"/api-reference/js-monitoring/delete-a-monitor"},{"title":"Get the active share link","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/js-monitoring/{id}/share","href":"/api-reference/js-monitoring/get-the-active-share-link"},{"title":"Create a share link","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/js-monitoring/{id}/share","href":"/api-reference/js-monitoring/create-a-share-link"},{"title":"Revoke the share link","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/js-monitoring/{id}/share","href":"/api-reference/js-monitoring/revoke-the-share-link"}]},{"group":"Leads","pages":[{"title":"List resources","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/leads","href":"/api-reference/leads/list-resources"},{"title":"Create a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/leads","href":"/api-reference/leads/create-a-resource"},{"title":"List top leads","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/leads/top","href":"/api-reference/leads/list-top-leads"},{"title":"Get a lead","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/leads/{id}","href":"/api-reference/leads/get-a-lead"},{"title":"Update a resource (partial)","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/leads/{id}","href":"/api-reference/leads/update-a-resource-partial"},{"title":"Delete a lead","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/leads/{id}","href":"/api-reference/leads/delete-a-lead"},{"title":"Open a Hackbot hunt for a lead","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/leads/{id}/hackbot","href":"/api-reference/leads/open-a-hackbot-hunt-for-a-lead"},{"title":"Get the active share link","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/leads/{id}/share","href":"/api-reference/leads/get-the-active-share-link"},{"title":"Create a share link","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/leads/{id}/share","href":"/api-reference/leads/create-a-share-link"},{"title":"Revoke the share link","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/leads/{id}/share","href":"/api-reference/leads/revoke-the-share-link"}]},{"group":"MCP Key","pages":[{"title":"Get the MCP key status","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/mcp-key","href":"/api-reference/mcp-key/get-the-mcp-key-status"},{"title":"Reveal the MCP key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/mcp-key/reveal","href":"/api-reference/mcp-key/reveal-the-mcp-key"},{"title":"Rotate the MCP key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/mcp-key/rotate","href":"/api-reference/mcp-key/rotate-the-mcp-key"}]},{"group":"Memories","pages":[{"title":"List agent memories","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/memories","href":"/api-reference/memories/list-agent-memories"},{"title":"Get one memory","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/memories/{id}","href":"/api-reference/memories/get-one-memory"},{"title":"Forget one memory","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/memories/{id}","href":"/api-reference/memories/forget-one-memory"}]},{"group":"Notification Channels","pages":[{"title":"List resources","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/notification-channels","href":"/api-reference/notification-channels/list-resources"},{"title":"Create a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/notification-channels","href":"/api-reference/notification-channels/create-a-resource"},{"title":"Get a resource by id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/notification-channels/{id}","href":"/api-reference/notification-channels/get-a-resource-by-id"},{"title":"Update a resource (partial)","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/notification-channels/{id}","href":"/api-reference/notification-channels/update-a-resource-partial"},{"title":"Delete a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/notification-channels/{id}","href":"/api-reference/notification-channels/delete-a-resource"},{"title":"Send a test notification","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/notification-channels/{id}/test","href":"/api-reference/notification-channels/send-a-test-notification"}]},{"group":"Notification Event Preferences","pages":[{"title":"List event preferences","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/notification-event-preferences","href":"/api-reference/notification-event-preferences/list-event-preferences"},{"title":"Set event preferences","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/notification-event-preferences","href":"/api-reference/notification-event-preferences/set-event-preferences"}]},{"group":"Notifications","pages":[{"title":"List resources","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/notifications","href":"/api-reference/notifications/list-resources"},{"title":"Create a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/notifications","href":"/api-reference/notifications/create-a-resource"},{"title":"Mark all notifications read","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/notifications/read-all","href":"/api-reference/notifications/mark-all-notifications-read"},{"title":"Get a resource by id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/notifications/{id}","href":"/api-reference/notifications/get-a-resource-by-id"},{"title":"Update a resource (partial)","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/notifications/{id}","href":"/api-reference/notifications/update-a-resource-partial"},{"title":"Delete a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/notifications/{id}","href":"/api-reference/notifications/delete-a-resource"},{"title":"Mark a notification read","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/notifications/{id}/read","href":"/api-reference/notifications/mark-a-notification-read"}]},{"group":"OOB","pages":[{"title":"List OOB correlation registrations","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/oob/correlations","href":"/api-reference/oob/list-oob-correlation-registrations"},{"title":"Register an OOB correlation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/oob/correlations","href":"/api-reference/oob/register-an-oob-correlation"},{"title":"Delete an OOB correlation","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/oob/correlations/{correlationId}","href":"/api-reference/oob/delete-an-oob-correlation"},{"title":"Get the OOB endpoint","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/oob/endpoint","href":"/api-reference/oob/get-the-oob-endpoint"},{"title":"List recorded interactions","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/oob/interactions","href":"/api-reference/oob/list-recorded-interactions"},{"title":"Clear interactions","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/oob/interactions","href":"/api-reference/oob/clear-interactions"},{"title":"Delete an interaction","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/oob/interactions/{id}","href":"/api-reference/oob/delete-an-interaction"},{"title":"Delete the OOB subdomain","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/oob/subdomain","href":"/api-reference/oob/delete-the-oob-subdomain"},{"title":"Regenerate the OOB subdomain","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/oob/subdomain/regenerate","href":"/api-reference/oob/regenerate-the-oob-subdomain"}]},{"group":"Provider Keys","pages":[{"title":"List provider keys","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/provider-keys","href":"/api-reference/provider-keys/list-provider-keys"},{"title":"Store a provider key","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/provider-keys","href":"/api-reference/provider-keys/store-a-provider-key"},{"title":"List models for every stored provider key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/provider-keys/models","href":"/api-reference/provider-keys/list-models-for-every-stored-provider-key"},{"title":"Delete a provider key","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/provider-keys/{provider}","href":"/api-reference/provider-keys/delete-a-provider-key"},{"title":"Select the model for a provider","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/provider-keys/{provider}/model","href":"/api-reference/provider-keys/select-the-model-for-a-provider"},{"title":"List models for a provider key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/provider-keys/{provider}/models","href":"/api-reference/provider-keys/list-models-for-a-provider-key"},{"title":"Reveal an integration provider key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/provider-keys/{provider}/reveal","href":"/api-reference/provider-keys/reveal-an-integration-provider-key"}]},{"group":"Public Shares","pages":[{"title":"Resolve a public share","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/public/{resourceType}/{token}","href":"/api-reference/public-shares/resolve-a-public-share"}]},{"group":"Reinforcements","pages":[{"title":"List reinforcements","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/reinforcements","href":"/api-reference/reinforcements/list-reinforcements"},{"title":"Create a reinforcement","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/reinforcements","href":"/api-reference/reinforcements/create-a-reinforcement"},{"title":"Generate reinforcements","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/reinforcements/generate","href":"/api-reference/reinforcements/generate-reinforcements"},{"title":"Get a resource by id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/reinforcements/{id}","href":"/api-reference/reinforcements/get-a-resource-by-id"},{"title":"Not supported","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/reinforcements/{id}","href":"/api-reference/reinforcements/not-supported"},{"title":"Delete a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/reinforcements/{id}","href":"/api-reference/reinforcements/delete-a-resource"},{"title":"Update a reinforcement","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /api/reinforcements/{id}","href":"/api-reference/reinforcements/update-a-reinforcement"}]},{"group":"Reports","pages":[{"title":"List reports","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/reports","href":"/api-reference/reports/list-reports"},{"title":"Queue a report","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/reports","href":"/api-reference/reports/queue-a-report"},{"title":"Get a resource by id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/reports/{id}","href":"/api-reference/reports/get-a-resource-by-id"},{"title":"Not supported","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/reports/{id}","href":"/api-reference/reports/not-supported"},{"title":"Delete a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/reports/{id}","href":"/api-reference/reports/delete-a-resource"},{"title":"Not supported","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /api/reports/{id}","href":"/api-reference/reports/not-supported-1"},{"title":"Edit report content","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /api/reports/{id}/content","href":"/api-reference/reports/edit-report-content"},{"title":"Retry report generation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/reports/{id}/retry","href":"/api-reference/reports/retry-report-generation"},{"title":"Get the active share link","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/reports/{id}/share","href":"/api-reference/reports/get-the-active-share-link"},{"title":"Create a share link","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/reports/{id}/share","href":"/api-reference/reports/create-a-share-link"},{"title":"Revoke the share link","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/reports/{id}/share","href":"/api-reference/reports/revoke-the-share-link"}]},{"group":"Scans","pages":[{"title":"List scans","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/scans","href":"/api-reference/scans/list-scans"},{"title":"Create a scan","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/scans","href":"/api-reference/scans/create-a-scan"},{"title":"Get a scan","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/scans/{id}","href":"/api-reference/scans/get-a-scan"},{"title":"Update a scan or its schedule","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/scans/{id}","href":"/api-reference/scans/update-a-scan-or-its-schedule"},{"title":"Delete a scan","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/scans/{id}","href":"/api-reference/scans/delete-a-scan"},{"title":"Rerun a scan","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/scans/{id}/rescan","href":"/api-reference/scans/rerun-a-scan"},{"title":"Pause or resume a schedule","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /api/scans/{id}/toggle","href":"/api-reference/scans/pause-or-resume-a-schedule"}]},{"group":"Schedules","pages":[{"title":"List schedules","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/schedules","href":"/api-reference/schedules/list-schedules"},{"title":"Trigger a scheduled scan now","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/schedules","href":"/api-reference/schedules/trigger-a-scheduled-scan-now"},{"title":"Get a resource by id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/schedules/{id}","href":"/api-reference/schedules/get-a-resource-by-id"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/schedules/{id}","href":"/api-reference/schedules/update-a-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/schedules/{id}","href":"/api-reference/schedules/delete-a-schedule"},{"title":"Pause or resume a schedule","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /api/schedules/{id}/toggle","href":"/api-reference/schedules/pause-or-resume-a-schedule"}]},{"group":"Tools","pages":[{"title":"List built-in recon tools","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/tools/builtin","href":"/api-reference/tools/list-built-in-recon-tools"}]},{"group":"User Profiles","pages":[{"title":"Get the user profile","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/user-profiles/me","href":"/api-reference/user-profiles/get-the-user-profile"},{"title":"Update the user profile","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/user-profiles/me","href":"/api-reference/user-profiles/update-the-user-profile"},{"title":"Cancel scheduled deletion","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/user-profiles/me/cancel-deletion","href":"/api-reference/user-profiles/cancel-scheduled-deletion"},{"title":"Reset all account data","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/user-profiles/me/reset-data","href":"/api-reference/user-profiles/reset-all-account-data"},{"title":"Schedule account deletion","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/user-profiles/me/schedule-deletion","href":"/api-reference/user-profiles/schedule-account-deletion"},{"title":"Set weekly digest opt-in","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/user-profiles/me/weekly-digest","href":"/api-reference/user-profiles/set-weekly-digest-opt-in"}]},{"group":"V1","pages":[{"title":"Get the current session","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/v1/whoami","href":"/api-reference/v1/get-the-current-session"}]},{"group":"Vulnerabilities","pages":[{"title":"List resources","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/vulnerabilities","href":"/api-reference/vulnerabilities/list-resources"},{"title":"Create a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/vulnerabilities","href":"/api-reference/vulnerabilities/create-a-resource"},{"title":"Get a resource by id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/vulnerabilities/{id}","href":"/api-reference/vulnerabilities/get-a-resource-by-id"},{"title":"Update a resource (partial)","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/vulnerabilities/{id}","href":"/api-reference/vulnerabilities/update-a-resource-partial"},{"title":"Delete a resource","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/vulnerabilities/{id}","href":"/api-reference/vulnerabilities/delete-a-resource"},{"title":"Get the active share link","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/vulnerabilities/{id}/share","href":"/api-reference/vulnerabilities/get-the-active-share-link"},{"title":"Create a share link","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/vulnerabilities/{id}/share","href":"/api-reference/vulnerabilities/create-a-share-link"},{"title":"Revoke the share link","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/vulnerabilities/{id}/share","href":"/api-reference/vulnerabilities/revoke-the-share-link"}]},{"group":"Workflows","pages":[{"title":"List resources","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/workflows","href":"/api-reference/workflows/list-resources"},{"title":"Create a workflow","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/workflows","href":"/api-reference/workflows/create-a-workflow"},{"title":"Get a resource by id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/workflows/{id}","href":"/api-reference/workflows/get-a-resource-by-id"},{"title":"Update a workflow","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/workflows/{id}","href":"/api-reference/workflows/update-a-workflow"},{"title":"Delete a workflow","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/workflows/{id}","href":"/api-reference/workflows/delete-a-workflow"},{"title":"Run a workflow","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/workflows/{id}/run","href":"/api-reference/workflows/run-a-workflow"}]},{"group":"Workspace","pages":[{"title":"Delete workspace artifacts","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /api/workspace/artifacts","href":"/api-reference/workspace/delete-workspace-artifacts"},{"title":"List workspace exports","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/workspace/exports","href":"/api-reference/workspace/list-workspace-exports"},{"title":"Start or extend a workspace export","deprecated":null,"version":null,"openapi":"/api/openapi.json post /api/workspace/exports","href":"/api-reference/workspace/start-or-extend-a-workspace-export"},{"title":"Read one workspace export","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/workspace/exports/{id}","href":"/api-reference/workspace/read-one-workspace-export"},{"title":"Download a workspace export","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/workspace/exports/{id}/download","href":"/api-reference/workspace/download-a-workspace-export"},{"title":"Read a workspace artifact","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/workspace/file/{file}","href":"/api-reference/workspace/read-a-workspace-artifact"},{"title":"Save a workspace artifact","deprecated":null,"version":null,"openapi":"/api/openapi.json put /api/workspace/file/{file}","href":"/api-reference/workspace/save-a-workspace-artifact"},{"title":"Download a workspace artifact","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/workspace/raw/{file}","href":"/api-reference/workspace/download-a-workspace-artifact"},{"title":"List workspace artifacts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /api/workspace/tree","href":"/api-reference/workspace/list-workspace-artifacts"}]},{"group":"Health","pages":[{"title":"GET /health","deprecated":null,"version":null,"openapi":"/api/openapi.json get /health","href":"/api-reference/health/get-health"}]}]}]}]},"basePath":"","title":"Create a new API key for a user - Attaxr","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}