Back to top

Projects

Project Management

Retrieve all projects
GET
/projects

Returns a collection of projects that the current user is a member of.

  • Parameters
  • include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"projects": [
    		{
    			"id": "string",
    			"name": "string",
    			"created_at": "string",
    			"updated_at": "string",
    			"max_devices": "object",
    			"members": [
    				{
    					"href": "string"
    				}
    			],
    			"memberships": [
    				{
    					"href": "string"
    				}
    			],
    			"network_status": "object",
    			"invitations": [
    				{
    					"href": "string"
    				}
    			],
    			"payment_method": [
    				{
    					"href": "string"
    				}
    			],
    			"devices": [
    				{
    					"href": "string"
    				}
    			],
    			"ssh_keys": [
    				{
    					"href": "string"
    				}
    			],
    			"volumes": [
    				{
    					"href": "string"
    				}
    			],
    			"bgp_config": {
    				"href": "string"
    			}
    		}
    	],
    	"meta": {
    		"first": {
    			"href": "string"
    		},
    		"previous": {
    			"href": "string"
    		},
    		"self": {
    			"href": "string"
    		},
    		"next": {
    			"href": "string"
    		},
    		"last": {
    			"href": "string"
    		},
    		"total": "integer"
    	}
    }
  • Response  401   unauthorized
Create a project
/projects

Creates a new projects and adds the current user as a member.

  • Parameters
  • project
     (required) in body

    Project to create

    {
    	"name": "string",
    	"payment_method_id": "string"
    }
  • Response  201   created
  • {
    	"id": "string",
    	"name": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"max_devices": "object",
    	"members": [
    		{
    			"href": "string"
    		}
    	],
    	"memberships": [
    		{
    			"href": "string"
    		}
    	],
    	"network_status": "object",
    	"invitations": [
    		{
    			"href": "string"
    		}
    	],
    	"payment_method": [
    		{
    			"href": "string"
    		}
    	],
    	"devices": [
    		{
    			"href": "string"
    		}
    	],
    	"ssh_keys": [
    		{
    			"href": "string"
    		}
    	],
    	"volumes": [
    		{
    			"href": "string"
    		}
    	],
    	"bgp_config": {
    		"href": "string"
    	}
    }
  • Response  401   unauthorized
  • Response  422   unprocessable entity
Retrieve a project
GET
/projects/{id}

Returns a single project if the user has access

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"name": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"max_devices": "object",
    	"members": [
    		{
    			"href": "string"
    		}
    	],
    	"memberships": [
    		{
    			"href": "string"
    		}
    	],
    	"network_status": "object",
    	"invitations": [
    		{
    			"href": "string"
    		}
    	],
    	"payment_method": [
    		{
    			"href": "string"
    		}
    	],
    	"devices": [
    		{
    			"href": "string"
    		}
    	],
    	"ssh_keys": [
    		{
    			"href": "string"
    		}
    	],
    	"volumes": [
    		{
    			"href": "string"
    		}
    	],
    	"bgp_config": {
    		"href": "string"
    	}
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Update the project
PUT
/projects/{id}

Updates the project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    project
     (required) in body

    Project to update

    {
    	"name": "string",
    	"payment_method_id": "string"
    }
  • Response  200   ok
  • {
    	"id": "string",
    	"name": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"max_devices": "object",
    	"members": [
    		{
    			"href": "string"
    		}
    	],
    	"memberships": [
    		{
    			"href": "string"
    		}
    	],
    	"network_status": "object",
    	"invitations": [
    		{
    			"href": "string"
    		}
    	],
    	"payment_method": [
    		{
    			"href": "string"
    		}
    	],
    	"devices": [
    		{
    			"href": "string"
    		}
    	],
    	"ssh_keys": [
    		{
    			"href": "string"
    		}
    	],
    	"volumes": [
    		{
    			"href": "string"
    		}
    	],
    	"bgp_config": {
    		"href": "string"
    	}
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Delete the project
/projects/{id}

Deletes the project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

  • Response  204   no content
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found