Create an app

curl --request POST \
  --url https://api.ravion.com/apps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "moduleInstanceId": "<string>",
    "name": "<string>",
    "branch": "<string>"
  }
}
'

import requests

url = "https://api.ravion.com/apps"

payload = { "data": {
        "moduleInstanceId": "<string>",
        "name": "<string>",
        "branch": "<string>"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({data: {moduleInstanceId: '<string>', name: '<string>', branch: '<string>'}})
};

fetch('https://api.ravion.com/apps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ravion.com/apps",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'moduleInstanceId' => '<string>',
        'name' => '<string>',
        'branch' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ravion.com/apps"

	payload := strings.NewReader("{\n  \"data\": {\n    \"moduleInstanceId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"branch\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.ravion.com/apps")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"moduleInstanceId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"branch\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ravion.com/apps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"moduleInstanceId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"branch\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "cpu": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "diskGib": 123,
    "domains": [
      {
        "domainId": "<string>",
        "exposure": "<string>",
        "name": "<string>",
        "records": [
          {
            "name": "<string>",
            "purpose": "VALIDATION",
            "type": "<string>",
            "value": "<string>"
          }
        ],
        "status": "PENDING",
        "error": "<string>"
      }
    ],
    "environmentId": "<string>",
    "id": "<string>",
    "memoryMib": 123,
    "moduleInstanceId": "<string>",
    "name": "<string>",
    "organizationId": "<string>",
    "projectId": "<string>",
    "status": "DEPLOYING",
    "updatedAt": "2023-11-07T05:31:56Z",
    "urls": [
      {
        "alternateUrls": [
          "<string>"
        ],
        "name": "<string>",
        "url": "<string>"
      }
    ],
    "branch": "<string>",
    "createdById": "<string>",
    "defaultBranch": "<string>",
    "definition": {
      "envNames": [
        "<string>"
      ],
      "expose": [
        {
          "healthCheckPath": "<string>",
          "name": "<string>",
          "port": 32768,
          "domains": [
            "<string>"
          ]
        }
      ],
      "kind": "compose",
      "workdir": "<string>",
      "compose": {
        "file": "<string>",
        "profiles": [
          "<string>"
        ],
        "services": [
          "<string>"
        ]
      },
      "cpu": 2,
      "description": "<string>",
      "diskGib": 2,
      "idleTimeoutSeconds": 1,
      "memoryMib": 2,
      "run": {
        "build": [
          "<string>"
        ],
        "start": [
          "<string>"
        ]
      }
    },
    "lastDeploy": {
      "createdAt": "2023-11-07T05:31:56Z",
      "dirty": true,
      "pipelineRunId": "<string>",
      "status": "QUEUED",
      "branch": "<string>",
      "commit": "<string>",
      "commitUrl": "<string>",
      "createdById": "<string>",
      "finishedAt": "2023-11-07T05:31:56Z"
    },
    "sandboxId": "<string>",
    "sandboxStatus": "PENDING"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

POST

apps

Create an app

curl --request POST \
  --url https://api.ravion.com/apps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "moduleInstanceId": "<string>",
    "name": "<string>",
    "branch": "<string>"
  }
}
'

import requests

url = "https://api.ravion.com/apps"

payload = { "data": {
        "moduleInstanceId": "<string>",
        "name": "<string>",
        "branch": "<string>"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({data: {moduleInstanceId: '<string>', name: '<string>', branch: '<string>'}})
};

fetch('https://api.ravion.com/apps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ravion.com/apps",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'moduleInstanceId' => '<string>',
        'name' => '<string>',
        'branch' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ravion.com/apps"

	payload := strings.NewReader("{\n  \"data\": {\n    \"moduleInstanceId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"branch\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.ravion.com/apps")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"moduleInstanceId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"branch\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ravion.com/apps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"moduleInstanceId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"branch\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "cpu": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "diskGib": 123,
    "domains": [
      {
        "domainId": "<string>",
        "exposure": "<string>",
        "name": "<string>",
        "records": [
          {
            "name": "<string>",
            "purpose": "VALIDATION",
            "type": "<string>",
            "value": "<string>"
          }
        ],
        "status": "PENDING",
        "error": "<string>"
      }
    ],
    "environmentId": "<string>",
    "id": "<string>",
    "memoryMib": 123,
    "moduleInstanceId": "<string>",
    "name": "<string>",
    "organizationId": "<string>",
    "projectId": "<string>",
    "status": "DEPLOYING",
    "updatedAt": "2023-11-07T05:31:56Z",
    "urls": [
      {
        "alternateUrls": [
          "<string>"
        ],
        "name": "<string>",
        "url": "<string>"
      }
    ],
    "branch": "<string>",
    "createdById": "<string>",
    "defaultBranch": "<string>",
    "definition": {
      "envNames": [
        "<string>"
      ],
      "expose": [
        {
          "healthCheckPath": "<string>",
          "name": "<string>",
          "port": 32768,
          "domains": [
            "<string>"
          ]
        }
      ],
      "kind": "compose",
      "workdir": "<string>",
      "compose": {
        "file": "<string>",
        "profiles": [
          "<string>"
        ],
        "services": [
          "<string>"
        ]
      },
      "cpu": 2,
      "description": "<string>",
      "diskGib": 2,
      "idleTimeoutSeconds": 1,
      "memoryMib": 2,
      "run": {
        "build": [
          "<string>"
        ],
        "start": [
          "<string>"
        ]
      }
    },
    "lastDeploy": {
      "createdAt": "2023-11-07T05:31:56Z",
      "dirty": true,
      "pipelineRunId": "<string>",
      "status": "QUEUED",
      "branch": "<string>",
      "commit": "<string>",
      "commitUrl": "<string>",
      "createdById": "<string>",
      "finishedAt": "2023-11-07T05:31:56Z"
    },
    "sandboxId": "<string>",
    "sandboxStatus": "PENDING"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

Body

application/json

data

object

required

The App Cluster and the name of a new app.

Show child attributes

Response

The request has succeeded and a new resource has been created as a result.

data

object

required

An app: a named microVM on an App Cluster, served at its URLs.

Show child attributes

Get started

API reference

Create an app

Body

Response