Skip to content

Latest commit

 

History

History
244 lines (165 loc) · 8.49 KB

ObjectSubnetApi.md

File metadata and controls

244 lines (165 loc) · 8.49 KB

ObjectSubnetApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
subnetCreateObjectV1 POST /1/object/subnet Create a new Subnet
subnetDeleteObjectV1 DELETE /1/object/subnet/{pkiSubnetID} Delete an existing Subnet
subnetEditObjectV1 PUT /1/object/subnet/{pkiSubnetID} Edit an existing Subnet
subnetGetObjectV2 GET /2/object/subnet/{pkiSubnetID} Retrieve an existing Subnet

subnetCreateObjectV1

-(NSURLSessionTask*) subnetCreateObjectV1WithSubnetCreateObjectV1Request: (SubnetCreateObjectV1Request*) subnetCreateObjectV1Request
        completionHandler: (void (^)(SubnetCreateObjectV1Response* output, NSError* error)) handler;

Create a new Subnet

The endpoint allows to create one or many elements at once.

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


SubnetCreateObjectV1Request* subnetCreateObjectV1Request = [[SubnetCreateObjectV1Request alloc] init]; // 

ObjectSubnetApi*apiInstance = [[ObjectSubnetApi alloc] init];

// Create a new Subnet
[apiInstance subnetCreateObjectV1WithSubnetCreateObjectV1Request:subnetCreateObjectV1Request
          completionHandler: ^(SubnetCreateObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectSubnetApi->subnetCreateObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
subnetCreateObjectV1Request SubnetCreateObjectV1Request*

Return type

SubnetCreateObjectV1Response*

Authorization

Authorization

HTTP request headers

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

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

subnetDeleteObjectV1

-(NSURLSessionTask*) subnetDeleteObjectV1WithPkiSubnetID: (NSNumber*) pkiSubnetID
        completionHandler: (void (^)(SubnetDeleteObjectV1Response* output, NSError* error)) handler;

Delete an existing Subnet

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiSubnetID = @56; // The unique ID of the Subnet

ObjectSubnetApi*apiInstance = [[ObjectSubnetApi alloc] init];

// Delete an existing Subnet
[apiInstance subnetDeleteObjectV1WithPkiSubnetID:pkiSubnetID
          completionHandler: ^(SubnetDeleteObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectSubnetApi->subnetDeleteObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiSubnetID NSNumber* The unique ID of the Subnet

Return type

SubnetDeleteObjectV1Response*

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

subnetEditObjectV1

-(NSURLSessionTask*) subnetEditObjectV1WithPkiSubnetID: (NSNumber*) pkiSubnetID
    subnetEditObjectV1Request: (SubnetEditObjectV1Request*) subnetEditObjectV1Request
        completionHandler: (void (^)(SubnetEditObjectV1Response* output, NSError* error)) handler;

Edit an existing Subnet

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiSubnetID = @56; // The unique ID of the Subnet
SubnetEditObjectV1Request* subnetEditObjectV1Request = [[SubnetEditObjectV1Request alloc] init]; // 

ObjectSubnetApi*apiInstance = [[ObjectSubnetApi alloc] init];

// Edit an existing Subnet
[apiInstance subnetEditObjectV1WithPkiSubnetID:pkiSubnetID
              subnetEditObjectV1Request:subnetEditObjectV1Request
          completionHandler: ^(SubnetEditObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectSubnetApi->subnetEditObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiSubnetID NSNumber* The unique ID of the Subnet
subnetEditObjectV1Request SubnetEditObjectV1Request*

Return type

SubnetEditObjectV1Response*

Authorization

Authorization

HTTP request headers

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

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

subnetGetObjectV2

-(NSURLSessionTask*) subnetGetObjectV2WithPkiSubnetID: (NSNumber*) pkiSubnetID
        completionHandler: (void (^)(SubnetGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Subnet

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiSubnetID = @56; // The unique ID of the Subnet

ObjectSubnetApi*apiInstance = [[ObjectSubnetApi alloc] init];

// Retrieve an existing Subnet
[apiInstance subnetGetObjectV2WithPkiSubnetID:pkiSubnetID
          completionHandler: ^(SubnetGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectSubnetApi->subnetGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiSubnetID NSNumber* The unique ID of the Subnet

Return type

SubnetGetObjectV2Response*

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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