Roboflow Docs
AppMore Resources
  • Roboflow Documentation
  • Quickstart
  • Roboflow Enterprise
  • Key Concepts
  • Workspaces
    • Create a Workspace
    • Add Team Members
    • Role-Based Access Control
    • Usage Based Pricing
    • Delete a Workspace
  • Workflows
    • Create a Workflow
    • Build a Workflow
    • Test a Workflow
    • Deploy a Workflow
    • Workflow Examples
      • Multimodal Model Workflow
    • Share a Workflow
      • Workflow Sharing Configuration
    • Advance Workflow Topics
      • JSON Editor
  • Datasets
    • Create a Project
    • Upload Data
      • Import Data from Cloud Providers
        • AWS S3 Bucket
        • Azure Blob Storage
        • Google Cloud Storage
      • Upload Video
      • Import from Roboflow Universe
    • Manage Batches
    • Search a Dataset
    • Create a Dataset Version
    • Preprocess Images
    • Create Augmented Images
    • Add Tags to Images
    • Manage Classes
    • Edit Keypoint Skeletons
    • Create an Annotation Attribute
    • Export Versions
    • Dataset Analytics
    • Merge Projects
    • Delete an Image
    • Delete a Version
    • Delete a Project
    • Project Folders
    • Publish Your Project
  • Annotate
    • Annotation Tools
    • Use Roboflow Annotate
      • Annotate Keypoints
      • Label Assist (AI Labeling)
      • Enhanced Smart Polygon with SAM (AI Labeling)
      • Smart Polygon (AI Labeling)
      • Keyboard Shortcuts
      • Comment on an Image
      • Annotation History
      • Similarity Search
      • Box Prompting (AI Labeling)
    • Automated Annotation with Auto Label
    • Collaborate on Annotations
    • Annotation Insights
    • Labeling Best Practices
  • Train
    • Train a Model
      • Train from a Universe Checkpoint
      • Train from Azure Vision
      • Train from Google Cloud
    • View Training Results
    • View Trained Models
    • Evaluate Trained Models
    • Evaluate Trained Models
    • Custom Training Notebooks
  • Deploy
    • Deployment Overview
      • Roboflow Managed Deployments Overview
    • Serverless Hosted API
      • Object Detection
      • Classification
      • Instance Segmentation
        • Semantic Segmentation
      • Keypoint Detection
      • Foundation Models
        • CLIP
        • OCR
        • YOLO-World
      • Video Inference
        • Use a Fine-Tuned Model
        • Use CLIP
        • Use Gaze Detection
        • API Reference
        • Video Inference JSON Output Format
      • Pre-Trained Model APIs
        • Blur People API
        • OCR API
        • Logistics API
        • Image Tagging API
        • People Detection API
        • Fish Detection API
        • Bird Detection API
        • PPE Detection API
        • Barcode Detection API
        • License Plate Detection API
        • Ceramic Defect Detection API
        • Metal Defect Detection API
    • Serverless Hosted API V2
    • Dedicated Deployments
      • How to create a dedicated deployment (Roboflow App)
      • How to create a dedicated deployment (Roboflow CLI)
      • How to use a dedicated deployment
      • How to manage dedicated deployment using HTTP APIs
    • SDKs
      • Python inference-sdk
      • Web Browser
        • inferencejs Reference
        • inferencejs Requirements
      • Lens Studio
        • Changelog - Lens Studio
      • Mobile iOS
      • Luxonis OAK
    • Upload Custom Model Weights
    • Download Roboflow Model Weights
    • Enterprise Deployment
      • License Server
      • Offline Mode
      • Kubernetes
      • Docker Compose
    • Model Monitoring
      • Alerting
  • Roboflow CLI
    • Introduction
    • Installation and Authentication
    • Getting Help
    • Upload Dataset
    • Download Dataset
    • Run Inference
  • API Reference
    • Introduction
    • Python Package
    • REST API Structure
    • Authentication
    • Workspace and Project IDs
    • Workspaces
    • Workspace Image Query
    • Batches
    • Annotation Jobs
    • Projects
      • Initialize
      • Create
      • Project Folders API
    • Images
      • Upload Images
      • Image Details
      • Upload Dataset
      • Upload an Annotation
      • Search
      • Tags
    • Versions
      • View a Version
      • Create a Project Version
    • Inference
    • Export Data
    • Train a Model
    • Annotation Insights
      • Annotation Insights (Legacy Endpoint)
    • Model Monitoring
      • Custom Metadata
      • Inference Result Stats
  • Support
    • Share a Workspace with Support
    • Account Deletion
Powered by GitBook
On this page

Was this helpful?

  1. Deploy
  2. Dedicated Deployments

How to manage dedicated deployment using HTTP APIs

Manage your dedicated deployment using our HTTP APIs.

PreviousHow to use a dedicated deploymentNextSDKs

Last updated 1 month ago

Was this helpful?

Notices:

  • All endpoints are hosted at https://roboflow.cloud.

  • Check the response code:

    • If it's 200, decode the response body as a JSON object.

    • Otherwise, the response body contains an error message as a string.

POST /add — create a dedicated deployment

Request Body Example (json)

{
	"api_key": API_KEY,
	"deployment_name": "dev-testing",
	"machine_type": "dev-gpu",
	"creator_email": YOUR_EMAIL_ADDRESS,
	"duration": 3.0,
	"inference_version": "latest",
	"min_replicas": 1,
	"max_replicas": 1
}

Request Body Schema (json)

  • api_key (string): required

  • deployment_name (string): required

  • machine_type (string): required

  • creator_email (string): required

  • duration (float): optional, unit is hour. default is 3

  • inference_version (string): optional, default is latest

  • min_replicas (integer): optional, default is 1

  • max_replicas (integer): optional, default is 1

Response Example (json)

{
	"deployment_id": "IwzJ5YLQ0iDhwzqoh3Ae",
	"deployment_name": "dev-testing",
	"machine_type": "dev-gpu",
	"creator_email": YOUR_EMAIL_ADDRESS,
	"creator_id": YOUR_USER_ID,
	"subdomain": "dev-testing",
	"domain": "dev-testing.roboflow.cloud",
	"duration": 3.0,
	"inference_version": "0.45.0",
	"max_replicas": 1,
	"min_replicas": 1,
	"num_replicas": 0,
	"status": "pending",
	"workspace_id": YOUR_WORKSPACE_ID,
	"workspace_url": YOUR_WORKSPACE_URL
}

Response Schema (json)

  • deployment_id (string): an unique identifier

  • deployment_name (string)

  • machine_type (string)

  • creator_email (string)

  • creator_id (string): the user id corresponding to creator_email

  • subdomain (string): not always the same as deployment_name, we'll add some suffix if the subdomain is already taken

  • domain (string)

  • duration (float)

  • inference_version (string)

  • min_replicas (integer)

  • max_replicas (integer)

  • num_replicas (integer): current available replicas

  • status (string)

  • workspace_id (string)

  • workspace_url (string)

GET /list — list dedicated deployments in your workspace

Query Parameters

  • api_key (string): required

  • show_expired (string): optional, default is false

  • show_deleted (string): optional, default is false

Response Example (json)

[
{
	"deployment_id": "IwzJ5YLQ0iDhwzqoh3Ae",
	"deployment_name": "dev-testing",
	"machine_type": "dev-gpu",
	"creator_email": YOUR_EMAIL_ADDRESS,
	"creator_id": YOUR_USER_ID,
	"subdomain": "dev-testing",
	"domain": "dev-testing.roboflow.cloud",
	"duration": 3.0,
	"inference_version": "0.45.0",
	"max_replicas": 1,
	"min_replicas": 1,
	"num_replicas": 0,
	"status": "pending",
	"workspace_id": YOUR_WORKSPACE_ID,
	"workspace_url": YOUR_WORKSPACE_URL
}
]

Response Schema (json)

a list of dedicated deployment entries, while each entry has the same schema as describe in the endpoint.

GET /get — get details of a dedicated deployment

Query Parameters

  • api_key (string): required

  • deployment_name (string): required

Response Example (json)

{
	"deployment_id": "IwzJ5YLQ0iDhwzqoh3Ae",
	"deployment_name": "dev-testing",
	"machine_type": "dev-gpu",
	"creator_email": YOUR_EMAIL_ADDRESS,
	"creator_id": YOUR_USER_ID,
	"subdomain": "dev-testing",
	"domain": "dev-testing.roboflow.cloud",
	"duration": 3.0,
	"inference_version": "0.45.0",
	"max_replicas": 1,
	"min_replicas": 1,
	"num_replicas": 0,
	"status": "pending",
	"workspace_id": YOUR_WORKSPACE_ID,
	"workspace_url": YOUR_WORKSPACE_URL
}

Response Schema (json)

the same schema as the response of the endpoint.

GET /get_log — get logs of a dedicated deployment

Query Parameters

  • api_key (string): required

  • deployment_name (string): required

  • max_entries (integer): optional, default is 50

  • from_timestamp (string): optional, in format, default is 1 hour before current time

  • to_timestamp (string): optional, in format, default is current time

Response Example (json)

[
	{
		"insert_id": "gpwrgrw55p7b9jdq",
		"payload": "INFO:     10.18.0.38:46296 - \"GET /info HTTP/1.1\" 200 OK",
		"severity": "INFO",
		"timestamp": "2025-01-22T13:23:14.209436+00:00"
	},
	{
		"insert_id": "mbieh16zdjvqp81j",
		"payload": "INFO:     10.18.0.38:46294 - \"GET /info HTTP/1.1\" 200 OK",
		"severity": "INFO",
		"timestamp": "2025-01-22T13:23:14.208738+00:00"
	},
	{
		"insert_id": "0odfnfwh8ts6e4jt",
		"payload": "INFO:     10.18.0.38:54650 - \"GET /info HTTP/1.1\" 200 OK",
		"severity": "INFO",
		"timestamp": "2025-01-22T13:22:14.209054+00:00"
	},
	{
		"insert_id": "s3nabhyhejuke6ub",
		"payload": "INFO:     10.18.0.38:54640 - \"GET /info HTTP/1.1\" 200 OK",
		"severity": "INFO",
		"timestamp": "2025-01-22T13:22:14.208329+00:00"
	},
	{
		"insert_id": "2cz5u3jx4ma22tl8",
		"payload": "INFO:     10.18.0.38:40264 - \"GET /info HTTP/1.1\" 200 OK",
		"severity": "INFO",
		"timestamp": "2025-01-22T13:21:14.209900+00:00"
	}
]

Response Schema (json)

a list of log entries, while each entry has following attributes:

  • insert_id (string): unique identifier for each log entry

  • payload (string): log content

  • severity (string)

  • timestamp (string)

POST /pause — pause a dedicated deployment

Request Body Example (json)

{
	"api_key": API_KEY,
	"deployment_name": "dev-testing"
}

Request Body Schema (json)

  • api_key (string): required

  • deployment_name (string): require

Response Example (json)

{
	"message": "OK"
}

Response Schema

  • message (string)

POST /resume — resume a dedicated deployment

Request Body Example (json)

{
	"api_key": API_KEY,
	"deployment_name": "dev-testing"
}

Request Body Schema (json)

  • api_key (string): required

  • deployment_name (string): require

Response Example (json)

{
	"message": "OK"
}

Response Schema

  • message (string)

POST /delete — delete a dedicated deployment

Request Body Example (json)

{
	"api_key": API_KEY,
	"deployment_name": "dev-testing"
}

Request Body Schema (json)

  • api_key (string): required

  • deployment_name (string): require

Response Example (json)

{
	"message": "OK"
}

Response Schema

  • message (string)

ISO 8601
ISO 8601
/add
/add