Networks

These are the endpoints for Networks. More information coming soon.


GET/v1/projects/{projectId}/networks

List networks

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    pageNumber
    Type
    integer
    Description
  • Name
    pageSize
    Type
    integer
    Description

Request

GET
/v1/projects/{projectId}/networks
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/networks' \
-H 'Accept: application/json'

Response

{
    "networks": [
        {
            "activeState": "string",
            "dataCenterId": "string",
            "externalIpAddress": "string",
            "gateway": "string",
            "id": "string",
            "initState": "string",
            "internalIpAddress": "string",
            "ipRange": "string",
            "priceHr": {
                "value": "string"
            },
            "shortState": "string",
            "size": "string"
        }
    ],
    "pageNumber": "integer",
    "pageSize": "integer",
    "totalCount": "integer"
}

POST/v1/projects/{projectId}/networks

Create network

Description for this endpoint is coming soon.

Body attributes

  • Name
    cidrPrefix
    Type
    string
    Description
  • Name
    dataCenterId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description
  • Name
    networkId
    Type
    string
    Description
  • Name
    vrouterSize
    Type
    string
    Description

Path attributes

  • Name
    projectId
    Type
    string
    Description

Request

POST
/v1/projects/{projectId}/networks
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/networks' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "cidrPrefix": "string",
    "dataCenterId": "string",
    "id": "string",
    "networkId": "string",
    "vrouterSize": "string"
}'

GET/v1/projects/{projectId}/networks/security-groups

List security groups

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    dataCenterId
    Type
    string
    Description
  • Name
    pageNumber
    Type
    integer
    Description
  • Name
    pageSize
    Type
    integer
    Description

Request

GET
/v1/projects/{projectId}/networks/security-groups
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/networks/security-groups' \
-H 'Accept: application/json'

Response

{
    "pageNumber": "integer",
    "pageSize": "integer",
    "securityGroups": [
        {
            "dataCenterId": "string",
            "description": "string",
            "id": "string",
            "projectId": "string",
            "rules": [
                {
                    "icmpType": "string",
                    "id": "string",
                    "ipRangeCidr": "string",
                    "ports": "string",
                    "protocol": "string",
                    "ruleType": "string"
                }
            ]
        }
    ],
    "totalCount": "integer"
}

GET/v1/projects/{projectId}/networks/security-groups/{id}

Get a security group

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description

Request

GET
/v1/projects/{projectId}/networks/security-groups/{id}
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/networks/security-groups/{id}' \
-H 'Accept: application/json'

Response

{
    "securityGroup": {
        "dataCenterId": "string",
        "description": "string",
        "id": "string",
        "projectId": "string",
        "rules": [
            {
                "icmpType": "string",
                "id": "string",
                "ipRangeCidr": "string",
                "ports": "string",
                "protocol": "string",
                "ruleType": "string"
            }
        ]
    }
}

DELETE/v1/projects/{projectId}/networks/security-groups/{id}

Delete security group

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description

Request

DELETE
/v1/projects/{projectId}/networks/security-groups/{id}
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/networks/security-groups/{id}' \
-H 'Accept: application/json'

GET/v1/projects/{projectId}/networks/{id}

Get network

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description

Request

GET
/v1/projects/{projectId}/networks/{id}
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/networks/{id}' \
-H 'Accept: application/json'

Response

{
    "network": {
        "activeState": "string",
        "dataCenterId": "string",
        "externalIpAddress": "string",
        "gateway": "string",
        "id": "string",
        "initState": "string",
        "internalIpAddress": "string",
        "ipRange": "string",
        "priceHr": {
            "value": "string"
        },
        "shortState": "string",
        "size": "string"
    }
}

DELETE/v1/projects/{projectId}/networks/{id}

Delete network

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description
  • Name
    networkId
    Type
    string
    Description

Request

DELETE
/v1/projects/{projectId}/networks/{id}
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/networks/{id}' \
-H 'Accept: application/json'

POST/v1/projects/{projectId}/networks/{id}/start

Start network

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description
  • Name
    networkId
    Type
    string
    Description

Request

POST
/v1/projects/{projectId}/networks/{id}/start
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/networks/{id}/start' \
-H 'Accept: application/json'

POST/v1/projects/{projectId}/networks/{id}/stop

Stop network

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description
  • Name
    networkId
    Type
    string
    Description

Request

POST
/v1/projects/{projectId}/networks/{id}/stop
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/networks/{id}/stop' \
-H 'Accept: application/json'

POST/v1/projects/{securityGroup.projectId}/networks/security-groups

Create security group

Description for this endpoint is coming soon.

Body attributes

  • Name
    dataCenterId
    Type
    string
    Description
  • Name
    description
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description
  • Name
    rules
    Type
    array
    Description

Path attributes

  • Name
    securityGroup.projectId
    Type
    string
    Description

Request

POST
/v1/projects/{securityGroup.projectId}/networks/security-groups
curl 'https://rest.compute.cudo.org/v1/projects/{securityGroup.projectId}/networks/security-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "dataCenterId": "string",
    "description": "string",
    "id": "string",
    "rules": "array"
}'

Response

{
    "securityGroup": {
        "dataCenterId": "string",
        "description": "string",
        "id": "string",
        "projectId": "string",
        "rules": [
            {
                "icmpType": "string",
                "id": "string",
                "ipRangeCidr": "string",
                "ports": "string",
                "protocol": "string",
                "ruleType": "string"
            }
        ]
    }
}

PATCH/v1/projects/{securityGroup.projectId}/networks/security-groups/{securityGroup.id}

Update security group

Description for this endpoint is coming soon.

Body attributes

  • Name
    dataCenterId
    Type
    string
    Description
  • Name
    description
    Type
    string
    Description
  • Name
    rules
    Type
    array
    Description

Path attributes

  • Name
    securityGroup.projectId
    Type
    string
    Description
  • Name
    securityGroup.id
    Type
    string
    Description

Request

PATCH
/v1/projects/{securityGroup.projectId}/networks/security-groups/{securityGroup.id}
curl 'https://rest.compute.cudo.org/v1/projects/{securityGroup.projectId}/networks/security-groups/{securityGroup.id}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "dataCenterId": "string",
    "description": "string",
    "rules": "array"
}'

Response

{
    "securityGroup": {
        "dataCenterId": "string",
        "description": "string",
        "id": "string",
        "projectId": "string",
        "rules": [
            {
                "icmpType": "string",
                "id": "string",
                "ipRangeCidr": "string",
                "ports": "string",
                "protocol": "string",
                "ruleType": "string"
            }
        ]
    }
}