Skip to content

EnvironmentApi.md

Latest commit

 

History

History
399 lines (300 loc) · 12.6 KB

EnvironmentApi.md

File metadata and controls

399 lines (300 loc) · 12.6 KB

Itofinity.Appveyor.Refit.Api.EnvironmentApi

All URIs are relative to https://ci.appveyor.com/api

Method HTTP request Description
AddEnvironment Post /environments Add environment
DeleteEnvironment Delete /environments/{deploymentEnvironmentId} Delete environment
GetEnvironmentDeployments Get /environments/{deploymentEnvironmentId}/deployments Get environment deployments
GetEnvironmentSettings Get /environments/{deploymentEnvironmentId}/settings Get environment settings
GetEnvironments Get /environments Get environments
UpdateEnvironment Put /environments Update environment

AddEnvironment

DeploymentEnvironmentWithSettings AddEnvironment (DeploymentEnvironmentAddition body)

Add environment

Example

using System;
using System.Diagnostics;
using Itofinity.Appveyor.Refit.Api;
using Itofinity.Appveyor.Refit.Client;
using Itofinity.Appveyor.Refit.Model;

namespace Example
{
    public class AddEnvironmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: apiToken
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new EnvironmentApi();
            var body = new DeploymentEnvironmentAddition(); // DeploymentEnvironmentAddition | 

            try
            {
                // Add environment
                DeploymentEnvironmentWithSettings result = apiInstance.AddEnvironment(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentApi.AddEnvironment: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body DeploymentEnvironmentAddition

Return type

DeploymentEnvironmentWithSettings

Authorization

apiToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteEnvironment

void DeleteEnvironment (int? deploymentEnvironmentId)

Delete environment

Example

using System;
using System.Diagnostics;
using Itofinity.Appveyor.Refit.Api;
using Itofinity.Appveyor.Refit.Client;
using Itofinity.Appveyor.Refit.Model;

namespace Example
{
    public class DeleteEnvironmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: apiToken
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new EnvironmentApi();
            var deploymentEnvironmentId = 56;  // int? | Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`) 

            try
            {
                // Delete environment
                apiInstance.DeleteEnvironment(deploymentEnvironmentId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentApi.DeleteEnvironment: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
deploymentEnvironmentId int? Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`)

Return type

void (empty response body)

Authorization

apiToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEnvironmentDeployments

DeploymentEnvironmentDeploymentsResults GetEnvironmentDeployments (int? deploymentEnvironmentId)

Get environment deployments

Example

using System;
using System.Diagnostics;
using Itofinity.Appveyor.Refit.Api;
using Itofinity.Appveyor.Refit.Client;
using Itofinity.Appveyor.Refit.Model;

namespace Example
{
    public class GetEnvironmentDeploymentsExample
    {
        public void main()
        {
            
            // Configure API key authorization: apiToken
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new EnvironmentApi();
            var deploymentEnvironmentId = 56;  // int? | Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`) 

            try
            {
                // Get environment deployments
                DeploymentEnvironmentDeploymentsResults result = apiInstance.GetEnvironmentDeployments(deploymentEnvironmentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentApi.GetEnvironmentDeployments: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
deploymentEnvironmentId int? Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`)

Return type

DeploymentEnvironmentDeploymentsResults

Authorization

apiToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEnvironmentSettings

DeploymentEnvironmentSettingsResults GetEnvironmentSettings (int? deploymentEnvironmentId)

Get environment settings

Example

using System;
using System.Diagnostics;
using Itofinity.Appveyor.Refit.Api;
using Itofinity.Appveyor.Refit.Client;
using Itofinity.Appveyor.Refit.Model;

namespace Example
{
    public class GetEnvironmentSettingsExample
    {
        public void main()
        {
            
            // Configure API key authorization: apiToken
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new EnvironmentApi();
            var deploymentEnvironmentId = 56;  // int? | Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`) 

            try
            {
                // Get environment settings
                DeploymentEnvironmentSettingsResults result = apiInstance.GetEnvironmentSettings(deploymentEnvironmentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentApi.GetEnvironmentSettings: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
deploymentEnvironmentId int? Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`)

Return type

DeploymentEnvironmentSettingsResults

Authorization

apiToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEnvironments

List GetEnvironments ()

Get environments

Example

using System;
using System.Diagnostics;
using Itofinity.Appveyor.Refit.Api;
using Itofinity.Appveyor.Refit.Client;
using Itofinity.Appveyor.Refit.Model;

namespace Example
{
    public class GetEnvironmentsExample
    {
        public void main()
        {
            
            // Configure API key authorization: apiToken
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new EnvironmentApi();

            try
            {
                // Get environments
                List<DeploymentEnvironmentLookupModel> result = apiInstance.GetEnvironments();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentApi.GetEnvironments: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

apiToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateEnvironment

DeploymentEnvironmentWithSettings UpdateEnvironment (DeploymentEnvironmentWithSettings body)

Update environment

Example

using System;
using System.Diagnostics;
using Itofinity.Appveyor.Refit.Api;
using Itofinity.Appveyor.Refit.Client;
using Itofinity.Appveyor.Refit.Model;

namespace Example
{
    public class UpdateEnvironmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: apiToken
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new EnvironmentApi();
            var body = new DeploymentEnvironmentWithSettings(); // DeploymentEnvironmentWithSettings | 

            try
            {
                // Update environment
                DeploymentEnvironmentWithSettings result = apiInstance.UpdateEnvironment(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentApi.UpdateEnvironment: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body DeploymentEnvironmentWithSettings

Return type

DeploymentEnvironmentWithSettings

Authorization

apiToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]