> ## Documentation Index > Fetch the complete documentation index at: https://docs.neo.projectdiscovery.io/llms.txt > Use this file to discover all available pages before exploring further. # Test a custom API source > Store an optional new credential and start a background job that tests authentication and one bounded sample request with the current configuration. Team admins only. The credential is write-only: Neo encrypts it immediately and never returns or logs it. The response carries only credential_configured. One test per source runs at a time, and a team runs at most 10 analyses and tests at once. A test of a disabled source records its result and leaves the source disabled. ## OpenAPI ````yaml /openapi/neo.public.openapi.json post /api/v1/triage/sources/{id}/test openapi: 3.1.0 info: contact: name: ProjectDiscovery url: https://neo.projectdiscovery.io description: Neo API Server - Security agent orchestration platform license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 title: Neo API version: 1.0.0 servers: - description: Production url: https://neo.api.projectdiscovery.io - description: Development url: https://neo.api.dev.projectdiscovery.io - description: Local development url: http://localhost:8080 security: [] tags: - description: Task execution and management name: Tasks - description: Agent listing and management name: Agents - description: Public agent directory name: Agent Directory - description: User file storage management name: Files - description: User working memory management name: Memory - description: Scheduled and recurring task management name: Schedules - description: Knowledge base and semantic search name: Knowledge - description: Encrypted user credentials and API keys name: Secrets - description: Neo API key management for programmatic access name: API Keys - description: User profile and account information name: User - description: Task and LLM usage tracking name: Usage - description: Bring Your Own Key provider management name: BYOK - description: Connect personal AI provider accounts and select them as a model source name: AI Connections - description: Model discovery and capabilities name: Models - description: Third-party integrations name: Integrations - description: Skill knowledge documents for agent prompts name: Skills - description: User-authored tools and toolkit management name: Dynamic Tools - description: Team management and member invitations name: Teams - description: Prompt library management and discovery name: Prompts - description: Slack bot integration for workspace installation and OAuth name: Slack - description: GitHub integration for PR reviews and repository management name: GitHub - description: Vulnerability issue tracking and management name: Issues - description: Subscription billing and plans name: Billing - description: Project management and member assignments name: Projects - description: SSH key pair generation and management for remote server access name: SSH Keys - description: Codebase structural analysis and mapping name: Codemaps - description: AI-generated codebase documentation and security analysis name: CodeWiki - description: Captured HTTP traffic query and replay name: Network Events - description: User and team API activity metadata name: Audit Logs - description: Vulnerability triage for HackerOne, GitHub, and Security Inbox name: Triage paths: /api/v1/triage/sources/{id}/test: parameters: - $ref: '#/components/parameters/TriageSourceId' post: tags: - Triage summary: Test a custom API source description: > Store an optional new credential and start a background job that tests authentication and one bounded sample request with the current configuration. Team admins only. The credential is write-only: Neo encrypts it immediately and never returns or logs it. The response carries only credential_configured. One test per source runs at a time, and a team runs at most 10 analyses and tests at once. A test of a disabled source records its result and leaves the source disabled. operationId: post-v1-triage-sources-id-test parameters: - $ref: '#/components/parameters/TriageSourceIdempotencyKey' requestBody: content: application/json: schema: $ref: '#/components/schemas/TriageSourceTestRequest' required: false responses: '202': content: application/json: schema: $ref: '#/components/schemas/TriageSourceJobAccepted' description: Test job accepted '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: > Invalid or incomplete credential (credential_incomplete), a configuration that is not complete (configuration_incomplete), a request template that carries a credential (credential_in_template), or you are not a member of a team '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Authentication required '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Only team admins can test sources '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Source not found in your team '409': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: > The source changed while the request ran (source_changed; reload it and try again), a job of this kind is already queued or running for the source (job_in_progress), or the team already has 10 analyses and tests queued or running (too_many_jobs) '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Unexpected server error '503': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: >- Custom sources are turned off (custom_sources_disabled), or the job could not be started (queue_unavailable); or this deployment has no custom source tables yet (custom_sources_unavailable) security: - BearerAuth: [] - ApiKeyAuth: [] components: parameters: TriageSourceId: description: Source id in: path name: id required: true schema: format: uuid type: string TriageSourceIdempotencyKey: description: > Optional key that makes a repeated request return the same job instead of starting another one. Without it, Neo derives a key from the source's configuration (a new manual synchronization gets a new key). in: header name: Idempotency-Key required: false schema: maxLength: 200 minLength: 1 type: string schemas: TriageSourceTestRequest: properties: credential: $ref: '#/components/schemas/TriageSourceCredential' type: object TriageSourceJobAccepted: properties: credential_configured: description: >- Returned by the test action. True when the source has a stored credential. type: boolean job_id: format: uuid type: string required: - job_id type: object ErrorResponse: properties: code: description: > Stable machine-readable error code — branch on this rather than matching the human `error`/`message` strings. `access_restricted` (HTTP 403) denies hosted Neo access under the access policy. On team invitations, param=email identifies a restricted recipient rather than the caller; show the error without redirecting the caller. Domain codes include `user_spending_cap_reached`, `project_spending_cap_reached`, and `insufficient_neo_credits`; Free/usage codes include `free_grant_challenge_required`, `free_usage_exhausted`, `free_task_budget_exhausted`, `model_not_available_on_free`, `sandbox_not_available_on_free` (cloud sandbox surfaces are not available on the Free plan; task files remain available from the task), `free_cannot_continue_managed_task` (a task that ran on the standard cloud sandbox cannot be continued on the Free plan; start a new task), `free_origin_not_supported` (integration-originated tasks are not available on the Free plan), `weekly_usage_limit_reached`, `billing_period_usage_limit_reached`, `topup_required`, `subscription_required`, and `isolated_workspace_purged`. Otherwise it mirrors the error kind (e.g. `forbidden`, `invalid_request`, `not_exists`, `already_exists`). example: user_spending_cap_reached type: string error: example: Bad request type: string error_id: description: Correlation id for a specific error instance, when present. type: string kind: description: Coarse error category (e.g. "forbidden request", "invalid request"). example: forbidden request type: string message: description: | Human-readable detail (the kind prefixed to the error). For display, not for branching. type: string param: description: >- Field rejected by the policy; email for a restricted invite recipient. type: string turnstile_site_key: description: | Public Cloudflare Turnstile site key returned only with `free_grant_challenge_required`, so the client can complete the invisible verification before retrying the request. type: string required: - error type: object TriageSourceCredential: description: > Write-only credential bundle. Fill the fields the authentication type needs: api_key (header or query API key), token (bearer), username and password (basic), client_id and client_secret (OAuth client credentials). properties: api_key: maxLength: 4096 type: string writeOnly: true client_id: maxLength: 4096 type: string writeOnly: true client_secret: maxLength: 4096 type: string writeOnly: true password: maxLength: 4096 type: string writeOnly: true token: maxLength: 4096 type: string writeOnly: true username: maxLength: 4096 type: string writeOnly: true type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT authentication token scheme: bearer type: http ApiKeyAuth: description: Neo API key (neo_sk_* prefix) in: header name: X-Api-Key type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.