Latest Legacy

Get Details of All Applications

This API is used to get details of all the application that have been created under your VTS account.

API Endpoint

GET https://api.vtscom.net/v1/Account/{auth_id}/Application/

Arguments

subaccount string

ID of the subaccount, in case only subaccount applications are needed.
limit integer

Used to display the number of results per page. The maximum number of results that can be fetched is 20.
offset integer

Denotes the number of value items by which the results should be offset.

Returns

Returns a list of Application objects.

Example Request 

1
2
3
4
5
6
7

import vts

client = vts.RestClient('<auth_id>','<auth_token>')
response = client.applications.list(
    offset=0,
    limit=5, )
print(response)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

#
# Example for Application List
#
require 'rubygems'
require 'vts'

include VTS
include VTS::Exceptions

api = RestClient.new("<auth_id>","<auth_token>")

begin
  response = api.applications.list(
    limit: 5,
    offset: 0
  )
  puts response
rescue VTSRESTError => e
  puts 'Exception: ' + e.message
end

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

// Example for Application list

var vts = require('vts');

(function main() {
    'use strict';
    
   // If auth id and auth token are not specified, VTS will fetch them from the environment variables.
    var client = new vts.Client("<auth_id>","<auth_token>");
    client.applications.list(
        {
            offset: 0,
            limit: 5,
        },
    ).then(function (response) {
        console.log(response);
    }, function (err) {
        console.error(err);
    });
})();

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

<?php
/**
 * Example for Application list
 */
require 'vendor/autoload.php';
use vts\RestClient;
use vts\Exceptions\VTSRestException;
$client = new RestClient("<auth_id>","<auth_token>");

try {
    $response = $client->applications->list(
        [
            'subaccount' => 'SUBACCOUNT_ID',
            'limit' => 0,
            'offset' => 3
        ]
    );
    print_r($response);
}
catch (VTSRestException $ex) {
    print_r($ex);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

package net.vtscom.api.samples.application;

import java.io.IOException;
import net.vtscom.api.VTS;
import net.vtscom.api.exceptions.VTSRestException;
import net.vtscom.api.models.application.Application;
import net.vtscom.api.models.base.ListResponse;

/**
* Example for Application list
*/
class ApplicationList {
    public static void main(String [] args) {
        VTS.init("<auth_id>","<auth_token>");
        try {
            ListResponse<Application> response = Application.lister()
                .offset(0)
                .limit(5)
                .list();

            System.out.println(response);
        } catch (VTSRestException | IOException e) {
            e.printStackTrace();
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

/**
 * Example for Application List
 */
using System;
using System.Collections.Generic;
using VTS;
using VTS.Exception;

namespace VTSExamples
{
    internal class Program
    {
        public static void Main(string[] args)
        {
            var api = new VTSApi("<auth_id>","<auth_token>");
            try
            {
                var response = api.Application.List(
                    limit:5,
                    offset:0
                );
                Console.WriteLine(response);
            }
            catch (VTSRestException e)
            {
                Console.WriteLine("Exception: " + e.Message);
            }
        }
    }
}

1
2

curl -i --user AUTH_ID:AUTH_TOKEN \
    https://api.vtscom.net/v1/Account/{auth_id}/Application/

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

// Example for Application list
package main

import (
	"fmt"

	"github.com/vtscom/vts-go/v7"
)

func main() {
	client, err := vts.NewClient("<auth_id>", "<auth_token>", &vts.ClientOptions{})
	if err != nil {
		fmt.Print("Error", err.Error())
		return
	}
	response, err := client.Applications.List(
		vts.ApplicationListParams{
			Offset: 0,
			Limit:  5,
		},
	)
	if err != nil {
		fmt.Print("Error", err.Error())
		return
	}
	fmt.Printf("Response: %#v\n", response)
}