dots

app

list-apps

original documentation

try {
  const input = {
    page: 1, // number
    per_page: 100, // number
    with_projects: false, // boolean
  };
  const {data:{apps}} = await dots.app.listApps(input);
  console.log(apps);
} catch (error) {
  console.log(error);
}

get-app

original documentation

try {
  const input = {
    app_id: 'string', // string
  };
  const {data:{app}} = await dots.app.listApps(input);
  console.log(app);
} catch (error) {
  console.log(error);
}

create-app

original documentation

try {
  const input = {
    spec: {}, // IAppSpec
    project_id: '', // string
  };
  const {data:{app}} = await dots.app.createApp(input);
  console.log(app);
} catch (error) {
  console.log(error);
}

update-app

original documentation

try {
  const input = {
    spec: {}, // IAppSpec
    app_id: '', // string
  };
  const {data:{app}} = await dots.app.updateApp(input);
  console.log(app);
} catch (error) {
  console.log(error);
}

delete-app

original documentation

try {
  const input = {
    app_id: '', // string
  };
  const {status} = await dots.app.deleteApp(input);
  console.log(status);
} catch (error) {
  console.log(error);
}

get-active-deployment-logs

original documentation

try {
  const input = {
    app_id: '', // string
    component_name: '', // string
    follow: true // boolean
    pod_connection_timeout: '', // string
    type: '', // string
  };
  const {data} = await dots.app.getActiveDeploymentLogs(input);
  console.log(data);
} catch (error) {
  console.log(error);
}

run-app-detection

original documentation

try {
  const input = {
    git: {}, // GitSpec
    github: {}, // GithubSpec
    commit_sha: '', // strin
    component_type: '', // string
  };
  const {data:{components}} = await dots.app.runAppDetection(input);
  console.log(components);
} catch (error) {
  console.log(error);
}

list-app-deployments

original documentation

try {
  const input = {
    app_id: '', // string
    page: 1, // number
    per_page: 100, // number
  };
  const {data:{deployments}} = await dots.app.listAppDeployments(input);
  console.log(deployments);
} catch (error) {
  console.log(error);
}

get-app-deployment

original documentation

try {
  const input = {
    app_id: '', // string
    deployment_id: '', // string
  };
  const {data:{deployment}} = await dots.app.getAppDeployment(input);
  console.log(deployment);
} catch (error) {
  console.log(error);
}

create-app-deployment

original documentation

try {
  const input = {
    app_id: '', // string
    force_build: false, // boolean
  };
  const {data:{deployment}} = await dots.app.createAppDeployment(input);
  console.log(deployment);
} catch (error) {
  console.log(error);
}

cancel-app-deployment

original documentation

try {
  const input = {
    app_id: '', // string
    deployment_id: '', // string
  };
  const {data:{deployment}} = await dots.app.cancelAppDeployment(input);
  console.log(deployment);
} catch (error) {
  console.log(error);
}

get-app-deployment-logs

original documentation

try {
  const input = {
    app_id: '', // string
    component_name: '', // string
    deployment_id: '', // string
    follow: true, // boolean
    pod_connection_timeout: '', // string
    type: '', // string
  };
  const {data:{live_url}} = await dots.app.getAppDeploymentLogs(input);
  console.log(live_url);
} catch (error) {
  console.log(error);
}

get-aggregated-app-deployment-logs

original documentation

try {
  const input = {
    app_id: '', // string
    component_name: '', // string
    deployment_id: '', // string
    follow: true, // boolean
    pod_connection_timeout: '', // string
    type: '', // string
  };
  const {data:{live_url}} = await dots.app.getAggregatedAppDeploymentLogs(input);
  console.log(live_url);
} catch (error) {
  console.log(error);
}

This site is open source. Improve this page.