# Broker Panel Docs

## Docs

- [Authentication](https://broker-docs.newyorkcityservers.com/api/authentication.md): Authenticate with API keys using the Authorization Bearer header.
- [IP Firewall](https://broker-docs.newyorkcityservers.com/api/firewall.md): The API IP whitelist requirement and how to configure it.
- [API Overview](https://broker-docs.newyorkcityservers.com/api/overview.md): Base URL, versioning, and the standard response format for the Broker Panel v1 API.
- [Invoices Report](https://broker-docs.newyorkcityservers.com/api/reports/invoices-report.md): Generate an invoice report and send it to email recipients.
- [Services Report](https://broker-docs.newyorkcityservers.com/api/reports/services-report.md): Generate a services report and send it as an Excel email attachment.
- [List Requests](https://broker-docs.newyorkcityservers.com/api/requests/list-requests.md): List and filter the service requests in your broker account.
- [Manage Request](https://broker-docs.newyorkcityservers.com/api/requests/manage-request.md): Approve or deny a pending service request.
- [Sandbox Mode](https://broker-docs.newyorkcityservers.com/api/sandbox-mode.md): How sk_test keys behave, simulated responses, and which endpoints are affected.
- [Cancel Service](https://broker-docs.newyorkcityservers.com/api/services/cancel.md): Submit immediate cancellation for a service
- [Change Service Password](https://broker-docs.newyorkcityservers.com/api/services/change-password.md): Set or generate a new password for an eligible VPS service.
- [Create Service](https://broker-docs.newyorkcityservers.com/api/services/create-service.md): Create a VPS service or submit a service request for approval.
- [Downgrade Service](https://broker-docs.newyorkcityservers.com/api/services/downgrade.md): Submit a service plan downgrade for background processing.
- [Get Service](https://broker-docs.newyorkcityservers.com/api/services/get-service.md): Get one broker-owned service and its VPS credentials by service number.
- [List Services](https://broker-docs.newyorkcityservers.com/api/services/list-services.md): List and filter the services in your broker account.
- [Upgrade Service](https://broker-docs.newyorkcityservers.com/api/services/upgrade.md): Submit a service plan upgrade for background processing.
- [Verify API Access](https://broker-docs.newyorkcityservers.com/api/verify-api-access.md): Choose the correct authentication check and verify an integration before using service endpoints.
- [Account Settings](https://broker-docs.newyorkcityservers.com/broker/account-settings.md): Manage your personal details, view broker information, set email notifications, and choose a display timezone.
- [Invoices](https://broker-docs.newyorkcityservers.com/broker/billing/invoices.md): View invoice history, open invoice details, make available payments, and get invoice PDFs.
- [Billing Overview](https://broker-docs.newyorkcityservers.com/broker/billing/overview.md): Learn what Billing & Invoices provides, who can access it, and how card and bank wire billing differ.
- [Payment Methods & Autopay](https://broker-docs.newyorkcityservers.com/broker/billing/payment-methods.md): Manage cards, understand automatic billing with the default card, and find Bank Wire Transfer instructions.
- [Brand](https://broker-docs.newyorkcityservers.com/broker/customization/brand.md): Set broker brand colors and manage image assets in the Brand page.
- [Email Settings](https://broker-docs.newyorkcityservers.com/broker/customization/email-settings.md): Review and store reply-to values for the broker account.
- [Email Templates](https://broker-docs.newyorkcityservers.com/broker/customization/email-templates.md): Create, edit, preview, test, and manage broker email templates.
- [Dashboard Tour](https://broker-docs.newyorkcityservers.com/broker/dashboard-tour.md): Learn how to use the Broker Panel sidebar, header, alerts, dashboard cards, and news feed.
- [API Keys](https://broker-docs.newyorkcityservers.com/broker/integrations/api-keys.md): Create and manage API keys, control key access, and configure the API firewall whitelist.
- [API Logs](https://broker-docs.newyorkcityservers.com/broker/integrations/api-logs.md): Review broker API request history and use log details to investigate failed requests safely.
- [API Overview](https://broker-docs.newyorkcityservers.com/broker/integrations/api-overview.md): Use the Broker Panel API for supported service, request, and report workflows.
- [Form Center](https://broker-docs.newyorkcityservers.com/broker/integrations/form-center.md): Create, publish, and manage VPS service request forms.
- [Publish and Embed Forms](https://broker-docs.newyorkcityservers.com/broker/integrations/form-embedding.md): Publish a public form, allow embed domains, set trusted IPs, and review submissions.
- [Logging In & MFA](https://broker-docs.newyorkcityservers.com/broker/logging-in.md): Sign in to the Broker Panel, set up two-factor authentication, use backup codes, and sign out.
- [Reports](https://broker-docs.newyorkcityservers.com/broker/reports/reports.md): Generate service and paid invoice reports for your broker account.
- [Scheduled Reports](https://broker-docs.newyorkcityservers.com/broker/reports/scheduled-reports.md): Create and manage automatic email delivery for services and invoice reports.
- [Roles & Team Management](https://broker-docs.newyorkcityservers.com/broker/roles-and-team.md): Understand broker admin and staff permissions, and manage team member accounts.
- [Cancel Services](https://broker-docs.newyorkcityservers.com/broker/services/cancellations.md): Cancel one or more services, send a warning, approve a request, and revert a recent cancellation.
- [Services Overview](https://broker-docs.newyorkcityservers.com/broker/services/overview.md): View, search, filter, and open your client services from the Services page.
- [Upgrade or Downgrade a Service Plan](https://broker-docs.newyorkcityservers.com/broker/services/plan-changes.md): Select a new service plan, submit the change, and track its request and billing status.
- [Requests](https://broker-docs.newyorkcityservers.com/broker/services/requests.md): Review service requests, use queue filters, and approve or deny broker actions.
- [Service Details](https://broker-docs.newyorkcityservers.com/broker/services/service-details.md): Open a client service, review its status and details, protect its credentials, and choose the next action.
- [Broker Panel Overview](https://broker-docs.newyorkcityservers.com/index.md): Learn what Broker Panel does, who uses it, and how to manage client services, requests, billing, reports, integrations, branding, and account settings.

## OpenAPI Specs

- [openapi](https://broker-docs.newyorkcityservers.com/api/openapi.yaml)