Floatplane REST API

ACPCreatorAgreementV2

editCreatorAgreement

Edit Creator Agreement

TODO


/api/acp/v2/creatoragreement/edit

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creatoragreement/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorAgreementV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorAgreementV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorAgreementV2Api apiInstance = new ACPCreatorAgreementV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.editCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementV2Api#editCreatorAgreement");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorAgreementV2Api;

public class ACPCreatorAgreementV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorAgreementV2Api apiInstance = new ACPCreatorAgreementV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.editCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementV2Api#editCreatorAgreement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorAgreementV2Api *apiInstance = [[ACPCreatorAgreementV2Api alloc] init];

// Edit Creator Agreement
[apiInstance editCreatorAgreementWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorAgreementV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editCreatorAgreement(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorAgreementV2Api();

            try {
                // Edit Creator Agreement
                oas_any_type_not_mapped result = apiInstance.editCreatorAgreement();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorAgreementV2Api.editCreatorAgreement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorAgreementV2Api();

try {
    $result = $api_instance->editCreatorAgreement();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorAgreementV2Api->editCreatorAgreement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorAgreementV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorAgreementV2Api->new();

eval {
    my $result = $api_instance->editCreatorAgreement();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorAgreementV2Api->editCreatorAgreement: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorAgreementV2Api()

try:
    # Edit Creator Agreement
    api_response = api_instance.edit_creator_agreement()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorAgreementV2Api->editCreatorAgreement: %s\n" % e)
extern crate ACPCreatorAgreementV2Api;

pub fn main() {

    let mut context = ACPCreatorAgreementV2Api::Context::default();
    let result = client.editCreatorAgreement(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorAgreement

Get Creator Agreement

TODO


/api/acp/v2/creatoragreement

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creatoragreement"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorAgreementV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorAgreementV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorAgreementV2Api apiInstance = new ACPCreatorAgreementV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementV2Api#getCreatorAgreement");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorAgreementV2Api;

public class ACPCreatorAgreementV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorAgreementV2Api apiInstance = new ACPCreatorAgreementV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementV2Api#getCreatorAgreement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorAgreementV2Api *apiInstance = [[ACPCreatorAgreementV2Api alloc] init];

// Get Creator Agreement
[apiInstance getCreatorAgreementWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorAgreementV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorAgreement(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorAgreementV2Api();

            try {
                // Get Creator Agreement
                oas_any_type_not_mapped result = apiInstance.getCreatorAgreement();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorAgreementV2Api.getCreatorAgreement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorAgreementV2Api();

try {
    $result = $api_instance->getCreatorAgreement();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorAgreementV2Api->getCreatorAgreement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorAgreementV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorAgreementV2Api->new();

eval {
    my $result = $api_instance->getCreatorAgreement();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorAgreementV2Api->getCreatorAgreement: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorAgreementV2Api()

try:
    # Get Creator Agreement
    api_response = api_instance.get_creator_agreement()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorAgreementV2Api->getCreatorAgreement: %s\n" % e)
extern crate ACPCreatorAgreementV2Api;

pub fn main() {

    let mut context = ACPCreatorAgreementV2Api::Context::default();
    let result = client.getCreatorAgreement(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listCreatorAgreement

List Creator Agreement

TODO


/api/acp/v2/creatoragreement/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creatoragreement/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorAgreementV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorAgreementV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorAgreementV2Api apiInstance = new ACPCreatorAgreementV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementV2Api#listCreatorAgreement");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorAgreementV2Api;

public class ACPCreatorAgreementV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorAgreementV2Api apiInstance = new ACPCreatorAgreementV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementV2Api#listCreatorAgreement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorAgreementV2Api *apiInstance = [[ACPCreatorAgreementV2Api alloc] init];

// List Creator Agreement
[apiInstance listCreatorAgreementWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorAgreementV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorAgreement(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorAgreementV2Api();

            try {
                // List Creator Agreement
                oas_any_type_not_mapped result = apiInstance.listCreatorAgreement();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorAgreementV2Api.listCreatorAgreement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorAgreementV2Api();

try {
    $result = $api_instance->listCreatorAgreement();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorAgreementV2Api->listCreatorAgreement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorAgreementV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorAgreementV2Api->new();

eval {
    my $result = $api_instance->listCreatorAgreement();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorAgreementV2Api->listCreatorAgreement: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorAgreementV2Api()

try:
    # List Creator Agreement
    api_response = api_instance.list_creator_agreement()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorAgreementV2Api->listCreatorAgreement: %s\n" % e)
extern crate ACPCreatorAgreementV2Api;

pub fn main() {

    let mut context = ACPCreatorAgreementV2Api::Context::default();
    let result = client.listCreatorAgreement(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ACPCreatorV2

checkCreatorURLAvailable

Check Creator Url Available

TODO


/api/acp/v2/creator/urlname/availability

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/urlname/availability"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.checkCreatorURLAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#checkCreatorURLAvailable");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.checkCreatorURLAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#checkCreatorURLAvailable");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Check Creator Url Available
[apiInstance checkCreatorURLAvailableWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkCreatorURLAvailable(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Check Creator Url Available
                oas_any_type_not_mapped result = apiInstance.checkCreatorURLAvailable();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.checkCreatorURLAvailable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->checkCreatorURLAvailable();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->checkCreatorURLAvailable: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->checkCreatorURLAvailable();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->checkCreatorURLAvailable: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Check Creator Url Available
    api_response = api_instance.check_creator_url_available()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->checkCreatorURLAvailable: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.checkCreatorURLAvailable(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


createCreator

Create Creator

TODO


/api/acp/v2/creator/create

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#createCreator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#createCreator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Create Creator
[apiInstance createCreatorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCreator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Create Creator
                oas_any_type_not_mapped result = apiInstance.createCreator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.createCreator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->createCreator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->createCreator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->createCreator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->createCreator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Create Creator
    api_response = api_instance.create_creator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->createCreator: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.createCreator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorCategories

Get Creator Categories

TODO


/api/acp/v2/creator/category/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/category/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorCategories();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#getCreatorCategories");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorCategories();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#getCreatorCategories");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Get Creator Categories
[apiInstance getCreatorCategoriesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorCategories(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Get Creator Categories
                oas_any_type_not_mapped result = apiInstance.getCreatorCategories();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.getCreatorCategories: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->getCreatorCategories();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->getCreatorCategories: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->getCreatorCategories();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->getCreatorCategories: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Get Creator Categories
    api_response = api_instance.get_creator_categories()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->getCreatorCategories: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.getCreatorCategories(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorDetails

Get Creator Details

TODO


/api/acp/v2/creator/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#getCreatorDetails");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#getCreatorDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Get Creator Details
[apiInstance getCreatorDetailsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorDetails(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Get Creator Details
                oas_any_type_not_mapped result = apiInstance.getCreatorDetails();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.getCreatorDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->getCreatorDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->getCreatorDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->getCreatorDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->getCreatorDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Get Creator Details
    api_response = api_instance.get_creator_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->getCreatorDetails: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.getCreatorDetails(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorList

Get Creator List

TODO


/api/acp/v2/creator/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#getCreatorList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#getCreatorList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Get Creator List
[apiInstance getCreatorListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Get Creator List
                oas_any_type_not_mapped result = apiInstance.getCreatorList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.getCreatorList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->getCreatorList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->getCreatorList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->getCreatorList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->getCreatorList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Get Creator List
    api_response = api_instance.get_creator_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->getCreatorList: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.getCreatorList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorsTitles

Get Creators Titles

TODO


/api/acp/v2/creator/titles

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/titles"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorsTitles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#getCreatorsTitles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorsTitles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#getCreatorsTitles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Get Creators Titles
[apiInstance getCreatorsTitlesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorsTitles(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Get Creators Titles
                oas_any_type_not_mapped result = apiInstance.getCreatorsTitles();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.getCreatorsTitles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->getCreatorsTitles();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->getCreatorsTitles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->getCreatorsTitles();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->getCreatorsTitles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Get Creators Titles
    api_response = api_instance.get_creators_titles()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->getCreatorsTitles: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.getCreatorsTitles(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getSubscriptionPlanList

Get Subscription Plan List

TODO


/api/acp/v2/creator/subscriptionplans/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/subscriptionplans/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getSubscriptionPlanList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#getSubscriptionPlanList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getSubscriptionPlanList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#getSubscriptionPlanList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Get Subscription Plan List
[apiInstance getSubscriptionPlanListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSubscriptionPlanList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Get Subscription Plan List
                oas_any_type_not_mapped result = apiInstance.getSubscriptionPlanList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.getSubscriptionPlanList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->getSubscriptionPlanList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->getSubscriptionPlanList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->getSubscriptionPlanList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->getSubscriptionPlanList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Get Subscription Plan List
    api_response = api_instance.get_subscription_plan_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->getSubscriptionPlanList: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.getSubscriptionPlanList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateCreator

Update Creator

TODO


/api/acp/v2/creator/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#updateCreator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#updateCreator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Update Creator
[apiInstance updateCreatorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCreator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Update Creator
                oas_any_type_not_mapped result = apiInstance.updateCreator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.updateCreator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->updateCreator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->updateCreator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->updateCreator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->updateCreator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Update Creator
    api_response = api_instance.update_creator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->updateCreator: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.updateCreator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateCreatorSubscriptionPlan

Update Creator Subscription Plan

TODO


/api/acp/v2/creator/subscriptionplan/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/subscriptionplan/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateCreatorSubscriptionPlan();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#updateCreatorSubscriptionPlan");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateCreatorSubscriptionPlan();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#updateCreatorSubscriptionPlan");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Update Creator Subscription Plan
[apiInstance updateCreatorSubscriptionPlanWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCreatorSubscriptionPlan(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Update Creator Subscription Plan
                oas_any_type_not_mapped result = apiInstance.updateCreatorSubscriptionPlan();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.updateCreatorSubscriptionPlan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->updateCreatorSubscriptionPlan();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->updateCreatorSubscriptionPlan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->updateCreatorSubscriptionPlan();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->updateCreatorSubscriptionPlan: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Update Creator Subscription Plan
    api_response = api_instance.update_creator_subscription_plan()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->updateCreatorSubscriptionPlan: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.updateCreatorSubscriptionPlan(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


uploadCard

Upload Card

TODO


/api/acp/v2/creator/card/upload

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/card/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadCard();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#uploadCard");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadCard();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#uploadCard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Upload Card
[apiInstance uploadCardWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadCard(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Upload Card
                oas_any_type_not_mapped result = apiInstance.uploadCard();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.uploadCard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->uploadCard();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->uploadCard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->uploadCard();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->uploadCard: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Upload Card
    api_response = api_instance.upload_card()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->uploadCard: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.uploadCard(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


uploadCover

Upload Cover

TODO


/api/acp/v2/creator/cover/upload

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/cover/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadCover();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#uploadCover");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadCover();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#uploadCover");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Upload Cover
[apiInstance uploadCoverWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadCover(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Upload Cover
                oas_any_type_not_mapped result = apiInstance.uploadCover();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.uploadCover: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->uploadCover();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->uploadCover: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->uploadCover();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->uploadCover: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Upload Cover
    api_response = api_instance.upload_cover()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->uploadCover: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.uploadCover(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


uploadIcon

Upload Icon

TODO


/api/acp/v2/creator/icon/upload

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/creator/icon/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV2Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadIcon();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#uploadIcon");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV2Api;

public class ACPCreatorV2ApiExample {
    public static void main(String[] args) {
        ACPCreatorV2Api apiInstance = new ACPCreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadIcon();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV2Api#uploadIcon");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV2Api *apiInstance = [[ACPCreatorV2Api alloc] init];

// Upload Icon
[apiInstance uploadIconWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadIcon(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV2Api();

            try {
                // Upload Icon
                oas_any_type_not_mapped result = apiInstance.uploadIcon();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV2Api.uploadIcon: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV2Api();

try {
    $result = $api_instance->uploadIcon();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV2Api->uploadIcon: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV2Api->new();

eval {
    my $result = $api_instance->uploadIcon();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV2Api->uploadIcon: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV2Api()

try:
    # Upload Icon
    api_response = api_instance.upload_icon()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV2Api->uploadIcon: %s\n" % e)
extern crate ACPCreatorV2Api;

pub fn main() {

    let mut context = ACPCreatorV2Api::Context::default();
    let result = client.uploadIcon(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ACPCreatorV3

createCreatorInviteCode

Create Creator Invite Code

TODO


/api/acp/v3/creator/invite/create

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v3/creator/invite/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV3Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV3Api apiInstance = new ACPCreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV3Api#createCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV3Api;

public class ACPCreatorV3ApiExample {
    public static void main(String[] args) {
        ACPCreatorV3Api apiInstance = new ACPCreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV3Api#createCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV3Api *apiInstance = [[ACPCreatorV3Api alloc] init];

// Create Creator Invite Code
[apiInstance createCreatorInviteCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCreatorInviteCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV3Api();

            try {
                // Create Creator Invite Code
                oas_any_type_not_mapped result = apiInstance.createCreatorInviteCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV3Api.createCreatorInviteCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV3Api();

try {
    $result = $api_instance->createCreatorInviteCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV3Api->createCreatorInviteCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV3Api->new();

eval {
    my $result = $api_instance->createCreatorInviteCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV3Api->createCreatorInviteCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV3Api()

try:
    # Create Creator Invite Code
    api_response = api_instance.create_creator_invite_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV3Api->createCreatorInviteCode: %s\n" % e)
extern crate ACPCreatorV3Api;

pub fn main() {

    let mut context = ACPCreatorV3Api::Context::default();
    let result = client.createCreatorInviteCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorInviteCodeList

Get Creator Invite Code List

TODO


/api/acp/v3/creator/invite/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v3/creator/invite/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorV3Api;

import java.io.File;
import java.util.*;

public class ACPCreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPCreatorV3Api apiInstance = new ACPCreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV3Api#getCreatorInviteCodeList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorV3Api;

public class ACPCreatorV3ApiExample {
    public static void main(String[] args) {
        ACPCreatorV3Api apiInstance = new ACPCreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorV3Api#getCreatorInviteCodeList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPCreatorV3Api *apiInstance = [[ACPCreatorV3Api alloc] init];

// Get Creator Invite Code List
[apiInstance getCreatorInviteCodeListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPCreatorV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorInviteCodeList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPCreatorV3Api();

            try {
                // Get Creator Invite Code List
                oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorV3Api.getCreatorInviteCodeList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorV3Api();

try {
    $result = $api_instance->getCreatorInviteCodeList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorV3Api->getCreatorInviteCodeList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorV3Api->new();

eval {
    my $result = $api_instance->getCreatorInviteCodeList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorV3Api->getCreatorInviteCodeList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorV3Api()

try:
    # Get Creator Invite Code List
    api_response = api_instance.get_creator_invite_code_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorV3Api->getCreatorInviteCodeList: %s\n" % e)
extern crate ACPCreatorV3Api;

pub fn main() {

    let mut context = ACPCreatorV3Api::Context::default();
    let result = client.getCreatorInviteCodeList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ACPDashboardV2

getJobStatus

Get Job Status

TODO


/api/acp/v2/dashboard/job/status/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/dashboard/job/status/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPDashboardV2Api;

import java.io.File;
import java.util.*;

public class ACPDashboardV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPDashboardV2Api apiInstance = new ACPDashboardV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getJobStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardV2Api#getJobStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPDashboardV2Api;

public class ACPDashboardV2ApiExample {
    public static void main(String[] args) {
        ACPDashboardV2Api apiInstance = new ACPDashboardV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getJobStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardV2Api#getJobStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPDashboardV2Api *apiInstance = [[ACPDashboardV2Api alloc] init];

// Get Job Status
[apiInstance getJobStatusWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPDashboardV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobStatus(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPDashboardV2Api();

            try {
                // Get Job Status
                oas_any_type_not_mapped result = apiInstance.getJobStatus();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPDashboardV2Api.getJobStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPDashboardV2Api();

try {
    $result = $api_instance->getJobStatus();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPDashboardV2Api->getJobStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPDashboardV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPDashboardV2Api->new();

eval {
    my $result = $api_instance->getJobStatus();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPDashboardV2Api->getJobStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPDashboardV2Api()

try:
    # Get Job Status
    api_response = api_instance.get_job_status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPDashboardV2Api->getJobStatus: %s\n" % e)
extern crate ACPDashboardV2Api;

pub fn main() {

    let mut context = ACPDashboardV2Api::Context::default();
    let result = client.getJobStatus(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


startJob

Start Job

TODO


/api/acp/v2/dashboard/job/start/

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/dashboard/job/start/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPDashboardV2Api;

import java.io.File;
import java.util.*;

public class ACPDashboardV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPDashboardV2Api apiInstance = new ACPDashboardV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.startJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardV2Api#startJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPDashboardV2Api;

public class ACPDashboardV2ApiExample {
    public static void main(String[] args) {
        ACPDashboardV2Api apiInstance = new ACPDashboardV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.startJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardV2Api#startJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPDashboardV2Api *apiInstance = [[ACPDashboardV2Api alloc] init];

// Start Job
[apiInstance startJobWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPDashboardV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startJob(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPDashboardV2Api();

            try {
                // Start Job
                oas_any_type_not_mapped result = apiInstance.startJob();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPDashboardV2Api.startJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPDashboardV2Api();

try {
    $result = $api_instance->startJob();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPDashboardV2Api->startJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPDashboardV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPDashboardV2Api->new();

eval {
    my $result = $api_instance->startJob();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPDashboardV2Api->startJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPDashboardV2Api()

try:
    # Start Job
    api_response = api_instance.start_job()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPDashboardV2Api->startJob: %s\n" % e)
extern crate ACPDashboardV2Api;

pub fn main() {

    let mut context = ACPDashboardV2Api::Context::default();
    let result = client.startJob(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


stopJob

Stop Job

TODO


/api/acp/v2/dashboard/job/stop/

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/dashboard/job/stop/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPDashboardV2Api;

import java.io.File;
import java.util.*;

public class ACPDashboardV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPDashboardV2Api apiInstance = new ACPDashboardV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.stopJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardV2Api#stopJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPDashboardV2Api;

public class ACPDashboardV2ApiExample {
    public static void main(String[] args) {
        ACPDashboardV2Api apiInstance = new ACPDashboardV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.stopJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardV2Api#stopJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPDashboardV2Api *apiInstance = [[ACPDashboardV2Api alloc] init];

// Stop Job
[apiInstance stopJobWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPDashboardV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopJob(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPDashboardV2Api();

            try {
                // Stop Job
                oas_any_type_not_mapped result = apiInstance.stopJob();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPDashboardV2Api.stopJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPDashboardV2Api();

try {
    $result = $api_instance->stopJob();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPDashboardV2Api->stopJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPDashboardV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPDashboardV2Api->new();

eval {
    my $result = $api_instance->stopJob();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPDashboardV2Api->stopJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPDashboardV2Api()

try:
    # Stop Job
    api_response = api_instance.stop_job()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPDashboardV2Api->stopJob: %s\n" % e)
extern crate ACPDashboardV2Api;

pub fn main() {

    let mut context = ACPDashboardV2Api::Context::default();
    let result = client.stopJob(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ACPFAQV2

createFaqArticle

Create Faq Article

TODO


/api/acp/v2/article/create

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/article/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQV2Api;

import java.io.File;
import java.util.*;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createFaqArticle();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#createFaqArticle");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQV2Api;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createFaqArticle();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#createFaqArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFAQV2Api *apiInstance = [[ACPFAQV2Api alloc] init];

// Create Faq Article
[apiInstance createFaqArticleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFAQV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFaqArticle(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFAQV2Api();

            try {
                // Create Faq Article
                oas_any_type_not_mapped result = apiInstance.createFaqArticle();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQV2Api.createFaqArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQV2Api();

try {
    $result = $api_instance->createFaqArticle();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQV2Api->createFaqArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQV2Api->new();

eval {
    my $result = $api_instance->createFaqArticle();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQV2Api->createFaqArticle: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQV2Api()

try:
    # Create Faq Article
    api_response = api_instance.create_faq_article()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQV2Api->createFaqArticle: %s\n" % e)
extern crate ACPFAQV2Api;

pub fn main() {

    let mut context = ACPFAQV2Api::Context::default();
    let result = client.createFaqArticle(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


createFaqSection

Create Faq Section

TODO


/api/acp/v2/section/create

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/section/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQV2Api;

import java.io.File;
import java.util.*;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createFaqSection();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#createFaqSection");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQV2Api;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createFaqSection();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#createFaqSection");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFAQV2Api *apiInstance = [[ACPFAQV2Api alloc] init];

// Create Faq Section
[apiInstance createFaqSectionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFAQV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFaqSection(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFAQV2Api();

            try {
                // Create Faq Section
                oas_any_type_not_mapped result = apiInstance.createFaqSection();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQV2Api.createFaqSection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQV2Api();

try {
    $result = $api_instance->createFaqSection();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQV2Api->createFaqSection: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQV2Api->new();

eval {
    my $result = $api_instance->createFaqSection();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQV2Api->createFaqSection: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQV2Api()

try:
    # Create Faq Section
    api_response = api_instance.create_faq_section()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQV2Api->createFaqSection: %s\n" % e)
extern crate ACPFAQV2Api;

pub fn main() {

    let mut context = ACPFAQV2Api::Context::default();
    let result = client.createFaqSection(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getFaqArticleDetails

Get Faq Article Details

TODO


/api/acp/v2/article/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/article/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQV2Api;

import java.io.File;
import java.util.*;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getFaqArticleDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#getFaqArticleDetails");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQV2Api;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getFaqArticleDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#getFaqArticleDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFAQV2Api *apiInstance = [[ACPFAQV2Api alloc] init];

// Get Faq Article Details
[apiInstance getFaqArticleDetailsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFAQV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFaqArticleDetails(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFAQV2Api();

            try {
                // Get Faq Article Details
                oas_any_type_not_mapped result = apiInstance.getFaqArticleDetails();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQV2Api.getFaqArticleDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQV2Api();

try {
    $result = $api_instance->getFaqArticleDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQV2Api->getFaqArticleDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQV2Api->new();

eval {
    my $result = $api_instance->getFaqArticleDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQV2Api->getFaqArticleDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQV2Api()

try:
    # Get Faq Article Details
    api_response = api_instance.get_faq_article_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQV2Api->getFaqArticleDetails: %s\n" % e)
extern crate ACPFAQV2Api;

pub fn main() {

    let mut context = ACPFAQV2Api::Context::default();
    let result = client.getFaqArticleDetails(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getFaqImages

Get Faq Images

TODO


/api/acp/v2/image/list

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/image/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQV2Api;

import java.io.File;
import java.util.*;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getFaqImages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#getFaqImages");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQV2Api;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getFaqImages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#getFaqImages");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFAQV2Api *apiInstance = [[ACPFAQV2Api alloc] init];

// Get Faq Images
[apiInstance getFaqImagesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFAQV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFaqImages(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFAQV2Api();

            try {
                // Get Faq Images
                oas_any_type_not_mapped result = apiInstance.getFaqImages();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQV2Api.getFaqImages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQV2Api();

try {
    $result = $api_instance->getFaqImages();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQV2Api->getFaqImages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQV2Api->new();

eval {
    my $result = $api_instance->getFaqImages();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQV2Api->getFaqImages: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQV2Api()

try:
    # Get Faq Images
    api_response = api_instance.get_faq_images()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQV2Api->getFaqImages: %s\n" % e)
extern crate ACPFAQV2Api;

pub fn main() {

    let mut context = ACPFAQV2Api::Context::default();
    let result = client.getFaqImages(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getFaqSectionDetails

Get Faq Section Details

TODO


/api/acp/v2/section/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/section/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQV2Api;

import java.io.File;
import java.util.*;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getFaqSectionDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#getFaqSectionDetails");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQV2Api;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getFaqSectionDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#getFaqSectionDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFAQV2Api *apiInstance = [[ACPFAQV2Api alloc] init];

// Get Faq Section Details
[apiInstance getFaqSectionDetailsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFAQV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFaqSectionDetails(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFAQV2Api();

            try {
                // Get Faq Section Details
                oas_any_type_not_mapped result = apiInstance.getFaqSectionDetails();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQV2Api.getFaqSectionDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQV2Api();

try {
    $result = $api_instance->getFaqSectionDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQV2Api->getFaqSectionDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQV2Api->new();

eval {
    my $result = $api_instance->getFaqSectionDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQV2Api->getFaqSectionDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQV2Api()

try:
    # Get Faq Section Details
    api_response = api_instance.get_faq_section_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQV2Api->getFaqSectionDetails: %s\n" % e)
extern crate ACPFAQV2Api;

pub fn main() {

    let mut context = ACPFAQV2Api::Context::default();
    let result = client.getFaqSectionDetails(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getFaqSectionsACP

Get Faq Sections

TODO


/api/acp/v2/section/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/section/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQV2Api;

import java.io.File;
import java.util.*;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getFaqSectionsACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#getFaqSectionsACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQV2Api;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getFaqSectionsACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#getFaqSectionsACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFAQV2Api *apiInstance = [[ACPFAQV2Api alloc] init];

// Get Faq Sections
[apiInstance getFaqSectionsACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFAQV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFaqSectionsACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFAQV2Api();

            try {
                // Get Faq Sections
                oas_any_type_not_mapped result = apiInstance.getFaqSectionsACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQV2Api.getFaqSectionsACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQV2Api();

try {
    $result = $api_instance->getFaqSectionsACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQV2Api->getFaqSectionsACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQV2Api->new();

eval {
    my $result = $api_instance->getFaqSectionsACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQV2Api->getFaqSectionsACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQV2Api()

try:
    # Get Faq Sections
    api_response = api_instance.get_faq_sections_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQV2Api->getFaqSectionsACP: %s\n" % e)
extern crate ACPFAQV2Api;

pub fn main() {

    let mut context = ACPFAQV2Api::Context::default();
    let result = client.getFaqSectionsACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateFaqArticle

Update Faq Article

TODO


/api/acp/v2/article/edit

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/article/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQV2Api;

import java.io.File;
import java.util.*;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateFaqArticle();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#updateFaqArticle");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQV2Api;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateFaqArticle();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#updateFaqArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFAQV2Api *apiInstance = [[ACPFAQV2Api alloc] init];

// Update Faq Article
[apiInstance updateFaqArticleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFAQV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateFaqArticle(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFAQV2Api();

            try {
                // Update Faq Article
                oas_any_type_not_mapped result = apiInstance.updateFaqArticle();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQV2Api.updateFaqArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQV2Api();

try {
    $result = $api_instance->updateFaqArticle();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQV2Api->updateFaqArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQV2Api->new();

eval {
    my $result = $api_instance->updateFaqArticle();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQV2Api->updateFaqArticle: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQV2Api()

try:
    # Update Faq Article
    api_response = api_instance.update_faq_article()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQV2Api->updateFaqArticle: %s\n" % e)
extern crate ACPFAQV2Api;

pub fn main() {

    let mut context = ACPFAQV2Api::Context::default();
    let result = client.updateFaqArticle(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateFaqSection

Update Faq Section

TODO


/api/acp/v2/section/edit

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/section/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQV2Api;

import java.io.File;
import java.util.*;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateFaqSection();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#updateFaqSection");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQV2Api;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateFaqSection();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#updateFaqSection");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFAQV2Api *apiInstance = [[ACPFAQV2Api alloc] init];

// Update Faq Section
[apiInstance updateFaqSectionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFAQV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateFaqSection(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFAQV2Api();

            try {
                // Update Faq Section
                oas_any_type_not_mapped result = apiInstance.updateFaqSection();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQV2Api.updateFaqSection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQV2Api();

try {
    $result = $api_instance->updateFaqSection();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQV2Api->updateFaqSection: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQV2Api->new();

eval {
    my $result = $api_instance->updateFaqSection();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQV2Api->updateFaqSection: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQV2Api()

try:
    # Update Faq Section
    api_response = api_instance.update_faq_section()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQV2Api->updateFaqSection: %s\n" % e)
extern crate ACPFAQV2Api;

pub fn main() {

    let mut context = ACPFAQV2Api::Context::default();
    let result = client.updateFaqSection(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


uploadFaqImage

Upload Faq Image

TODO


/api/acp/v2/image/upload

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/image/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQV2Api;

import java.io.File;
import java.util.*;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadFaqImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#uploadFaqImage");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQV2Api;

public class ACPFAQV2ApiExample {
    public static void main(String[] args) {
        ACPFAQV2Api apiInstance = new ACPFAQV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadFaqImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQV2Api#uploadFaqImage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFAQV2Api *apiInstance = [[ACPFAQV2Api alloc] init];

// Upload Faq Image
[apiInstance uploadFaqImageWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFAQV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadFaqImage(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFAQV2Api();

            try {
                // Upload Faq Image
                oas_any_type_not_mapped result = apiInstance.uploadFaqImage();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQV2Api.uploadFaqImage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQV2Api();

try {
    $result = $api_instance->uploadFaqImage();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQV2Api->uploadFaqImage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQV2Api->new();

eval {
    my $result = $api_instance->uploadFaqImage();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQV2Api->uploadFaqImage: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQV2Api()

try:
    # Upload Faq Image
    api_response = api_instance.upload_faq_image()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQV2Api->uploadFaqImage: %s\n" % e)
extern crate ACPFAQV2Api;

pub fn main() {

    let mut context = ACPFAQV2Api::Context::default();
    let result = client.uploadFaqImage(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ACPFeatureV2

getFeatureConfigs

Get Feature Configs

TODO


/api/acp/v2/feature/configs

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/feature/configs"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureV2Api;

import java.io.File;
import java.util.*;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getFeatureConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#getFeatureConfigs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureV2Api;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getFeatureConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#getFeatureConfigs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFeatureV2Api *apiInstance = [[ACPFeatureV2Api alloc] init];

// Get Feature Configs
[apiInstance getFeatureConfigsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFeatureV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeatureConfigs(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFeatureV2Api();

            try {
                // Get Feature Configs
                oas_any_type_not_mapped result = apiInstance.getFeatureConfigs();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureV2Api.getFeatureConfigs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureV2Api();

try {
    $result = $api_instance->getFeatureConfigs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureV2Api->getFeatureConfigs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureV2Api->new();

eval {
    my $result = $api_instance->getFeatureConfigs();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureV2Api->getFeatureConfigs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureV2Api()

try:
    # Get Feature Configs
    api_response = api_instance.get_feature_configs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureV2Api->getFeatureConfigs: %s\n" % e)
extern crate ACPFeatureV2Api;

pub fn main() {

    let mut context = ACPFeatureV2Api::Context::default();
    let result = client.getFeatureConfigs(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


saveFeature

Save Feature

TODO


/api/acp/v2/feature/save

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/feature/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureV2Api;

import java.io.File;
import java.util.*;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveFeature();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#saveFeature");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureV2Api;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveFeature();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#saveFeature");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFeatureV2Api *apiInstance = [[ACPFeatureV2Api alloc] init];

// Save Feature
[apiInstance saveFeatureWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFeatureV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveFeature(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFeatureV2Api();

            try {
                // Save Feature
                oas_any_type_not_mapped result = apiInstance.saveFeature();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureV2Api.saveFeature: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureV2Api();

try {
    $result = $api_instance->saveFeature();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureV2Api->saveFeature: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureV2Api->new();

eval {
    my $result = $api_instance->saveFeature();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureV2Api->saveFeature: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureV2Api()

try:
    # Save Feature
    api_response = api_instance.save_feature()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureV2Api->saveFeature: %s\n" % e)
extern crate ACPFeatureV2Api;

pub fn main() {

    let mut context = ACPFeatureV2Api::Context::default();
    let result = client.saveFeature(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


saveFeatureCategory

Save Feature Category

TODO


/api/acp/v2/feature/category/save

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/feature/category/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureV2Api;

import java.io.File;
import java.util.*;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureCategory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#saveFeatureCategory");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureV2Api;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureCategory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#saveFeatureCategory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFeatureV2Api *apiInstance = [[ACPFeatureV2Api alloc] init];

// Save Feature Category
[apiInstance saveFeatureCategoryWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFeatureV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveFeatureCategory(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFeatureV2Api();

            try {
                // Save Feature Category
                oas_any_type_not_mapped result = apiInstance.saveFeatureCategory();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureV2Api.saveFeatureCategory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureV2Api();

try {
    $result = $api_instance->saveFeatureCategory();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureV2Api->saveFeatureCategory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureV2Api->new();

eval {
    my $result = $api_instance->saveFeatureCategory();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureV2Api->saveFeatureCategory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureV2Api()

try:
    # Save Feature Category
    api_response = api_instance.save_feature_category()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureV2Api->saveFeatureCategory: %s\n" % e)
extern crate ACPFeatureV2Api;

pub fn main() {

    let mut context = ACPFeatureV2Api::Context::default();
    let result = client.saveFeatureCategory(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


saveFeatureDependencies

Save Feature Dependencies

TODO


/api/acp/v2/feature/dependencies/save

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/feature/dependencies/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureV2Api;

import java.io.File;
import java.util.*;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureDependencies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#saveFeatureDependencies");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureV2Api;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureDependencies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#saveFeatureDependencies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFeatureV2Api *apiInstance = [[ACPFeatureV2Api alloc] init];

// Save Feature Dependencies
[apiInstance saveFeatureDependenciesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFeatureV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveFeatureDependencies(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFeatureV2Api();

            try {
                // Save Feature Dependencies
                oas_any_type_not_mapped result = apiInstance.saveFeatureDependencies();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureV2Api.saveFeatureDependencies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureV2Api();

try {
    $result = $api_instance->saveFeatureDependencies();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureV2Api->saveFeatureDependencies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureV2Api->new();

eval {
    my $result = $api_instance->saveFeatureDependencies();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureV2Api->saveFeatureDependencies: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureV2Api()

try:
    # Save Feature Dependencies
    api_response = api_instance.save_feature_dependencies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureV2Api->saveFeatureDependencies: %s\n" % e)
extern crate ACPFeatureV2Api;

pub fn main() {

    let mut context = ACPFeatureV2Api::Context::default();
    let result = client.saveFeatureDependencies(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


saveFeatureResolution

Save Feature Resolution

TODO


/api/acp/v2/feature/resolution/save

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/feature/resolution/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureV2Api;

import java.io.File;
import java.util.*;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureResolution();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#saveFeatureResolution");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureV2Api;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureResolution();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#saveFeatureResolution");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFeatureV2Api *apiInstance = [[ACPFeatureV2Api alloc] init];

// Save Feature Resolution
[apiInstance saveFeatureResolutionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFeatureV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveFeatureResolution(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFeatureV2Api();

            try {
                // Save Feature Resolution
                oas_any_type_not_mapped result = apiInstance.saveFeatureResolution();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureV2Api.saveFeatureResolution: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureV2Api();

try {
    $result = $api_instance->saveFeatureResolution();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureV2Api->saveFeatureResolution: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureV2Api->new();

eval {
    my $result = $api_instance->saveFeatureResolution();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureV2Api->saveFeatureResolution: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureV2Api()

try:
    # Save Feature Resolution
    api_response = api_instance.save_feature_resolution()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureV2Api->saveFeatureResolution: %s\n" % e)
extern crate ACPFeatureV2Api;

pub fn main() {

    let mut context = ACPFeatureV2Api::Context::default();
    let result = client.saveFeatureResolution(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


saveFeatureType

Save Feature Type

TODO


/api/acp/v2/feature/type/save

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/feature/type/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureV2Api;

import java.io.File;
import java.util.*;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureType();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#saveFeatureType");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureV2Api;

public class ACPFeatureV2ApiExample {
    public static void main(String[] args) {
        ACPFeatureV2Api apiInstance = new ACPFeatureV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureType();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureV2Api#saveFeatureType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPFeatureV2Api *apiInstance = [[ACPFeatureV2Api alloc] init];

// Save Feature Type
[apiInstance saveFeatureTypeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPFeatureV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveFeatureType(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPFeatureV2Api();

            try {
                // Save Feature Type
                oas_any_type_not_mapped result = apiInstance.saveFeatureType();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureV2Api.saveFeatureType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureV2Api();

try {
    $result = $api_instance->saveFeatureType();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureV2Api->saveFeatureType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureV2Api->new();

eval {
    my $result = $api_instance->saveFeatureType();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureV2Api->saveFeatureType: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureV2Api()

try:
    # Save Feature Type
    api_response = api_instance.save_feature_type()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureV2Api->saveFeatureType: %s\n" % e)
extern crate ACPFeatureV2Api;

pub fn main() {

    let mut context = ACPFeatureV2Api::Context::default();
    let result = client.saveFeatureType(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ACPModeratorV2

addCreatorModeratorACP

Add Creator Moderator

TODO


/api/acp/v2/moderator/creator/add/

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/moderator/creator/add/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorV2Api;

import java.io.File;
import java.util.*;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#addCreatorModeratorACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorV2Api;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#addCreatorModeratorACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPModeratorV2Api *apiInstance = [[ACPModeratorV2Api alloc] init];

// Add Creator Moderator
[apiInstance addCreatorModeratorACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPModeratorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCreatorModeratorACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPModeratorV2Api();

            try {
                // Add Creator Moderator
                oas_any_type_not_mapped result = apiInstance.addCreatorModeratorACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorV2Api.addCreatorModeratorACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorV2Api();

try {
    $result = $api_instance->addCreatorModeratorACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorV2Api->addCreatorModeratorACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorV2Api->new();

eval {
    my $result = $api_instance->addCreatorModeratorACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorV2Api->addCreatorModeratorACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorV2Api()

try:
    # Add Creator Moderator
    api_response = api_instance.add_creator_moderator_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorV2Api->addCreatorModeratorACP: %s\n" % e)
extern crate ACPModeratorV2Api;

pub fn main() {

    let mut context = ACPModeratorV2Api::Context::default();
    let result = client.addCreatorModeratorACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


createModerator

Create Moderator

TODO


/api/acp/v2/moderator/create

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/moderator/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorV2Api;

import java.io.File;
import java.util.*;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#createModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorV2Api;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#createModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPModeratorV2Api *apiInstance = [[ACPModeratorV2Api alloc] init];

// Create Moderator
[apiInstance createModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPModeratorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPModeratorV2Api();

            try {
                // Create Moderator
                oas_any_type_not_mapped result = apiInstance.createModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorV2Api.createModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorV2Api();

try {
    $result = $api_instance->createModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorV2Api->createModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorV2Api->new();

eval {
    my $result = $api_instance->createModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorV2Api->createModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorV2Api()

try:
    # Create Moderator
    api_response = api_instance.create_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorV2Api->createModerator: %s\n" % e)
extern crate ACPModeratorV2Api;

pub fn main() {

    let mut context = ACPModeratorV2Api::Context::default();
    let result = client.createModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getModeratorAvailableCreators

Get Moderator Available Creators

TODO


/api/acp/v2/moderator/creator/available

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/moderator/creator/available"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorV2Api;

import java.io.File;
import java.util.*;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorAvailableCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#getModeratorAvailableCreators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorV2Api;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorAvailableCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#getModeratorAvailableCreators");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPModeratorV2Api *apiInstance = [[ACPModeratorV2Api alloc] init];

// Get Moderator Available Creators
[apiInstance getModeratorAvailableCreatorsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPModeratorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModeratorAvailableCreators(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPModeratorV2Api();

            try {
                // Get Moderator Available Creators
                oas_any_type_not_mapped result = apiInstance.getModeratorAvailableCreators();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorV2Api.getModeratorAvailableCreators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorV2Api();

try {
    $result = $api_instance->getModeratorAvailableCreators();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorV2Api->getModeratorAvailableCreators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorV2Api->new();

eval {
    my $result = $api_instance->getModeratorAvailableCreators();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorV2Api->getModeratorAvailableCreators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorV2Api()

try:
    # Get Moderator Available Creators
    api_response = api_instance.get_moderator_available_creators()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorV2Api->getModeratorAvailableCreators: %s\n" % e)
extern crate ACPModeratorV2Api;

pub fn main() {

    let mut context = ACPModeratorV2Api::Context::default();
    let result = client.getModeratorAvailableCreators(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getModeratorCreators

Get Moderator Creators

TODO


/api/acp/v2/moderator/creator/list/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/moderator/creator/list/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorV2Api;

import java.io.File;
import java.util.*;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#getModeratorCreators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorV2Api;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#getModeratorCreators");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPModeratorV2Api *apiInstance = [[ACPModeratorV2Api alloc] init];

// Get Moderator Creators
[apiInstance getModeratorCreatorsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPModeratorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModeratorCreators(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPModeratorV2Api();

            try {
                // Get Moderator Creators
                oas_any_type_not_mapped result = apiInstance.getModeratorCreators();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorV2Api.getModeratorCreators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorV2Api();

try {
    $result = $api_instance->getModeratorCreators();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorV2Api->getModeratorCreators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorV2Api->new();

eval {
    my $result = $api_instance->getModeratorCreators();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorV2Api->getModeratorCreators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorV2Api()

try:
    # Get Moderator Creators
    api_response = api_instance.get_moderator_creators()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorV2Api->getModeratorCreators: %s\n" % e)
extern crate ACPModeratorV2Api;

pub fn main() {

    let mut context = ACPModeratorV2Api::Context::default();
    let result = client.getModeratorCreators(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getModeratorList

Get Moderator List

TODO


/api/acp/v2/moderator/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/moderator/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorV2Api;

import java.io.File;
import java.util.*;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#getModeratorList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorV2Api;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#getModeratorList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPModeratorV2Api *apiInstance = [[ACPModeratorV2Api alloc] init];

// Get Moderator List
[apiInstance getModeratorListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPModeratorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModeratorList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPModeratorV2Api();

            try {
                // Get Moderator List
                oas_any_type_not_mapped result = apiInstance.getModeratorList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorV2Api.getModeratorList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorV2Api();

try {
    $result = $api_instance->getModeratorList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorV2Api->getModeratorList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorV2Api->new();

eval {
    my $result = $api_instance->getModeratorList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorV2Api->getModeratorList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorV2Api()

try:
    # Get Moderator List
    api_response = api_instance.get_moderator_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorV2Api->getModeratorList: %s\n" % e)
extern crate ACPModeratorV2Api;

pub fn main() {

    let mut context = ACPModeratorV2Api::Context::default();
    let result = client.getModeratorList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


removeCreatorModeratorACP

Remove Creator Moderator

TODO


/api/acp/v2/moderator/creator/remove

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/moderator/creator/remove"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorV2Api;

import java.io.File;
import java.util.*;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#removeCreatorModeratorACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorV2Api;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#removeCreatorModeratorACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPModeratorV2Api *apiInstance = [[ACPModeratorV2Api alloc] init];

// Remove Creator Moderator
[apiInstance removeCreatorModeratorACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPModeratorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeCreatorModeratorACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPModeratorV2Api();

            try {
                // Remove Creator Moderator
                oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorV2Api.removeCreatorModeratorACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorV2Api();

try {
    $result = $api_instance->removeCreatorModeratorACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorV2Api->removeCreatorModeratorACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorV2Api->new();

eval {
    my $result = $api_instance->removeCreatorModeratorACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorV2Api->removeCreatorModeratorACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorV2Api()

try:
    # Remove Creator Moderator
    api_response = api_instance.remove_creator_moderator_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorV2Api->removeCreatorModeratorACP: %s\n" % e)
extern crate ACPModeratorV2Api;

pub fn main() {

    let mut context = ACPModeratorV2Api::Context::default();
    let result = client.removeCreatorModeratorACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateGlobalModerator

Update Global Moderator

TODO


/api/acp/v2/moderator/update/global

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/moderator/update/global"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorV2Api;

import java.io.File;
import java.util.*;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#updateGlobalModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorV2Api;

public class ACPModeratorV2ApiExample {
    public static void main(String[] args) {
        ACPModeratorV2Api apiInstance = new ACPModeratorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorV2Api#updateGlobalModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPModeratorV2Api *apiInstance = [[ACPModeratorV2Api alloc] init];

// Update Global Moderator
[apiInstance updateGlobalModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPModeratorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateGlobalModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPModeratorV2Api();

            try {
                // Update Global Moderator
                oas_any_type_not_mapped result = apiInstance.updateGlobalModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorV2Api.updateGlobalModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorV2Api();

try {
    $result = $api_instance->updateGlobalModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorV2Api->updateGlobalModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorV2Api->new();

eval {
    my $result = $api_instance->updateGlobalModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorV2Api->updateGlobalModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorV2Api()

try:
    # Update Global Moderator
    api_response = api_instance.update_global_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorV2Api->updateGlobalModerator: %s\n" % e)
extern crate ACPModeratorV2Api;

pub fn main() {

    let mut context = ACPModeratorV2Api::Context::default();
    let result = client.updateGlobalModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ACPTranscodingV3

augmentOrder

Augment Order

TODO


/acp/v3/order/augment

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/order/augment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.augmentOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#augmentOrder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.augmentOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#augmentOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Augment Order
[apiInstance augmentOrderWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.augmentOrder(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Augment Order
                oas_any_type_not_mapped result = apiInstance.augmentOrder();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.augmentOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->augmentOrder();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->augmentOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->augmentOrder();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->augmentOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Augment Order
    api_response = api_instance.augment_order()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->augmentOrder: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.augmentOrder(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


createOrder

Create Order

TODO


/acp/v3/order/create

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/order/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#createOrder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#createOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Create Order
[apiInstance createOrderWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createOrder(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Create Order
                oas_any_type_not_mapped result = apiInstance.createOrder();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.createOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->createOrder();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->createOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->createOrder();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->createOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Create Order
    api_response = api_instance.create_order()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->createOrder: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.createOrder(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getContentACP

Get Content

TODO


/acp/v3/content

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/content"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getContentACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getContentACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getContentACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getContentACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Get Content
[apiInstance getContentACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContentACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Get Content
                oas_any_type_not_mapped result = apiInstance.getContentACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.getContentACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->getContentACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->getContentACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->getContentACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->getContentACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Get Content
    api_response = api_instance.get_content_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->getContentACP: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.getContentACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getContentList

Get Content List

TODO


/acp/v3/content/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/content/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getContentList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getContentList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getContentList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getContentList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Get Content List
[apiInstance getContentListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContentList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Get Content List
                oas_any_type_not_mapped result = apiInstance.getContentList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.getContentList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->getContentList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->getContentList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->getContentList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->getContentList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Get Content List
    api_response = api_instance.get_content_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->getContentList: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.getContentList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getJob

Get Job

TODO


/acp/v3/job

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/job"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Get Job
[apiInstance getJobWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJob(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Get Job
                oas_any_type_not_mapped result = apiInstance.getJob();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.getJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->getJob();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->getJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->getJob();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->getJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Get Job
    api_response = api_instance.get_job()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->getJob: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.getJob(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getOrder

Get Order

TODO


/acp/v3/order

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/order"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getOrder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Get Order
[apiInstance getOrderWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrder(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Get Order
                oas_any_type_not_mapped result = apiInstance.getOrder();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.getOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->getOrder();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->getOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->getOrder();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->getOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Get Order
    api_response = api_instance.get_order()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->getOrder: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.getOrder(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getOrderList

Get Order List

TODO


/acp/v3/order/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/order/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getOrderList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getOrderList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getOrderList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getOrderList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Get Order List
[apiInstance getOrderListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Get Order List
                oas_any_type_not_mapped result = apiInstance.getOrderList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.getOrderList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->getOrderList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->getOrderList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->getOrderList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->getOrderList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Get Order List
    api_response = api_instance.get_order_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->getOrderList: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.getOrderList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getTask

Get Task

TODO


/acp/v3/task

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/task"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getTask();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getTask");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getTask();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getTask");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Get Task
[apiInstance getTaskWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTask(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Get Task
                oas_any_type_not_mapped result = apiInstance.getTask();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.getTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->getTask();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->getTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->getTask();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->getTask: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Get Task
    api_response = api_instance.get_task()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->getTask: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.getTask(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUpload

Get Upload

TODO


/acp/v3/upload

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUpload();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getUpload");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUpload();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Get Upload
[apiInstance getUploadWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUpload(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Get Upload
                oas_any_type_not_mapped result = apiInstance.getUpload();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.getUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->getUpload();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->getUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->getUpload();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->getUpload: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Get Upload
    api_response = api_instance.get_upload()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->getUpload: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.getUpload(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUploadList

Get Upload List

TODO


/acp/v3/upload/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/upload/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUploadList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getUploadList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUploadList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#getUploadList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Get Upload List
[apiInstance getUploadListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUploadList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Get Upload List
                oas_any_type_not_mapped result = apiInstance.getUploadList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.getUploadList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->getUploadList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->getUploadList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->getUploadList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->getUploadList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Get Upload List
    api_response = api_instance.get_upload_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->getUploadList: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.getUploadList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


postContent

Post Content

TODO


/acp/v3/content

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/content"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Post Content
[apiInstance postContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Post Content
                oas_any_type_not_mapped result = apiInstance.postContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.postContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->postContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->postContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->postContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->postContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Post Content
    api_response = api_instance.post_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->postContent: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.postContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


postJob

Post Job

TODO


/acp/v3/job

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/job"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Post Job
[apiInstance postJobWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postJob(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Post Job
                oas_any_type_not_mapped result = apiInstance.postJob();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.postJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->postJob();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->postJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->postJob();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->postJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Post Job
    api_response = api_instance.post_job()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->postJob: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.postJob(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


postManager

Post Manager

TODO


/acp/v3/manager

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/manager"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postManager();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postManager");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postManager();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postManager");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Post Manager
[apiInstance postManagerWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postManager(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Post Manager
                oas_any_type_not_mapped result = apiInstance.postManager();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.postManager: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->postManager();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->postManager: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->postManager();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->postManager: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Post Manager
    api_response = api_instance.post_manager()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->postManager: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.postManager(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


postOrder

Post Order

TODO


/acp/v3/order

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/order"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postOrder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Post Order
[apiInstance postOrderWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postOrder(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Post Order
                oas_any_type_not_mapped result = apiInstance.postOrder();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.postOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->postOrder();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->postOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->postOrder();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->postOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Post Order
    api_response = api_instance.post_order()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->postOrder: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.postOrder(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


postTask

Post Task

TODO


/acp/v3/task

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/task"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postTask();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postTask");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postTask();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postTask");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Post Task
[apiInstance postTaskWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postTask(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Post Task
                oas_any_type_not_mapped result = apiInstance.postTask();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.postTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->postTask();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->postTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->postTask();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->postTask: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Post Task
    api_response = api_instance.post_task()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->postTask: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.postTask(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


postUpload

Post Upload

TODO


/acp/v3/upload

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/acp/v3/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingV3Api;

import java.io.File;
import java.util.*;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postUpload();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postUpload");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingV3Api;

public class ACPTranscodingV3ApiExample {
    public static void main(String[] args) {
        ACPTranscodingV3Api apiInstance = new ACPTranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.postUpload();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingV3Api#postUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPTranscodingV3Api *apiInstance = [[ACPTranscodingV3Api alloc] init];

// Post Upload
[apiInstance postUploadWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPTranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postUpload(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPTranscodingV3Api();

            try {
                // Post Upload
                oas_any_type_not_mapped result = apiInstance.postUpload();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingV3Api.postUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingV3Api();

try {
    $result = $api_instance->postUpload();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingV3Api->postUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingV3Api->new();

eval {
    my $result = $api_instance->postUpload();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingV3Api->postUpload: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingV3Api()

try:
    # Post Upload
    api_response = api_instance.post_upload()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingV3Api->postUpload: %s\n" % e)
extern crate ACPTranscodingV3Api;

pub fn main() {

    let mut context = ACPTranscodingV3Api::Context::default();
    let result = client.postUpload(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ACPUserV2

addUserSubscriptions

Add User Subscriptions

TODO


/api/acp/v2/user/subscription/add

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/subscription/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addUserSubscriptions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#addUserSubscriptions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addUserSubscriptions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#addUserSubscriptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Add User Subscriptions
[apiInstance addUserSubscriptionsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addUserSubscriptions(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Add User Subscriptions
                oas_any_type_not_mapped result = apiInstance.addUserSubscriptions();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.addUserSubscriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->addUserSubscriptions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->addUserSubscriptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->addUserSubscriptions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->addUserSubscriptions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Add User Subscriptions
    api_response = api_instance.add_user_subscriptions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->addUserSubscriptions: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.addUserSubscriptions(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


checkEmailAvailable

Check Email Available

TODO


/api/acp/v2/user/email/availability

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/email/availability"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.checkEmailAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#checkEmailAvailable");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.checkEmailAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#checkEmailAvailable");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Check Email Available
[apiInstance checkEmailAvailableWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkEmailAvailable(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Check Email Available
                oas_any_type_not_mapped result = apiInstance.checkEmailAvailable();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.checkEmailAvailable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->checkEmailAvailable();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->checkEmailAvailable: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->checkEmailAvailable();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->checkEmailAvailable: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Check Email Available
    api_response = api_instance.check_email_available()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->checkEmailAvailable: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.checkEmailAvailable(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


checkUsernameAvailable

Check Username Available

TODO


/api/acp/v2/user/username/availability

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/username/availability"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.checkUsernameAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#checkUsernameAvailable");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.checkUsernameAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#checkUsernameAvailable");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Check Username Available
[apiInstance checkUsernameAvailableWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkUsernameAvailable(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Check Username Available
                oas_any_type_not_mapped result = apiInstance.checkUsernameAvailable();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.checkUsernameAvailable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->checkUsernameAvailable();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->checkUsernameAvailable: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->checkUsernameAvailable();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->checkUsernameAvailable: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Check Username Available
    api_response = api_instance.check_username_available()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->checkUsernameAvailable: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.checkUsernameAvailable(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


createAdmin

Create Admin

TODO


/api/acp/v2/user/admin/create

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/admin/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#createAdmin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#createAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Create Admin
[apiInstance createAdminWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAdmin(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Create Admin
                oas_any_type_not_mapped result = apiInstance.createAdmin();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.createAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->createAdmin();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->createAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->createAdmin();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->createAdmin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Create Admin
    api_response = api_instance.create_admin()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->createAdmin: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.createAdmin(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


deleteUser

Delete User

TODO - Not used in Floatplane code.


/api/acp/v2/user/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#deleteUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#deleteUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Delete User
[apiInstance deleteUserWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteUser(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Delete User
                oas_any_type_not_mapped result = apiInstance.deleteUser();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->deleteUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->deleteUser();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->deleteUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Delete User
    api_response = api_instance.delete_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->deleteUser: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.deleteUser(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


findUser

Find User

TODO - Not used in Floatplane code.


/api/acp/v2/user/find

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/find"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.findUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#findUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.findUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#findUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Find User
[apiInstance findUserWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findUser(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Find User
                oas_any_type_not_mapped result = apiInstance.findUser();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.findUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->findUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->findUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->findUser();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->findUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Find User
    api_response = api_instance.find_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->findUser: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.findUser(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getPaymentProcessorData

Get Payment Processor Data

TODO


/api/acp/v2/user/payment/processor/data

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/payment/processor/data"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getPaymentProcessorData();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#getPaymentProcessorData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getPaymentProcessorData();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#getPaymentProcessorData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Get Payment Processor Data
[apiInstance getPaymentProcessorDataWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPaymentProcessorData(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Get Payment Processor Data
                oas_any_type_not_mapped result = apiInstance.getPaymentProcessorData();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.getPaymentProcessorData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->getPaymentProcessorData();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->getPaymentProcessorData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->getPaymentProcessorData();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->getPaymentProcessorData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Get Payment Processor Data
    api_response = api_instance.get_payment_processor_data()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->getPaymentProcessorData: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.getPaymentProcessorData(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserDetails

Get User Details

TODO


/api/acp/v2/user/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#getUserDetails");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#getUserDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Get User Details
[apiInstance getUserDetailsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserDetails(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Get User Details
                oas_any_type_not_mapped result = apiInstance.getUserDetails();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.getUserDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->getUserDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->getUserDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->getUserDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->getUserDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Get User Details
    api_response = api_instance.get_user_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->getUserDetails: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.getUserDetails(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserList

Get User List

TODO


/api/acp/v2/user/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#getUserList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#getUserList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Get User List
[apiInstance getUserListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Get User List
                oas_any_type_not_mapped result = apiInstance.getUserList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.getUserList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->getUserList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->getUserList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->getUserList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->getUserList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Get User List
    api_response = api_instance.get_user_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->getUserList: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.getUserList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserSubscriptions

Get User Subscriptions

TODO


/api/acp/v2/user/usersubscription/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/usersubscription/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserSubscriptions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#getUserSubscriptions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserSubscriptions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#getUserSubscriptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Get User Subscriptions
[apiInstance getUserSubscriptionsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserSubscriptions(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Get User Subscriptions
                oas_any_type_not_mapped result = apiInstance.getUserSubscriptions();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.getUserSubscriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->getUserSubscriptions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->getUserSubscriptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->getUserSubscriptions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->getUserSubscriptions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Get User Subscriptions
    api_response = api_instance.get_user_subscriptions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->getUserSubscriptions: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.getUserSubscriptions(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listUserInvoices

List User Invoices

TODO


/api/acp/v2/user/payment/invoice/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/payment/invoice/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listUserInvoices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#listUserInvoices");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listUserInvoices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#listUserInvoices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// List User Invoices
[apiInstance listUserInvoicesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUserInvoices(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // List User Invoices
                oas_any_type_not_mapped result = apiInstance.listUserInvoices();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.listUserInvoices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->listUserInvoices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->listUserInvoices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->listUserInvoices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->listUserInvoices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # List User Invoices
    api_response = api_instance.list_user_invoices()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->listUserInvoices: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.listUserInvoices(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


removeUserSubscription

Remove User Subscription

TODO


/api/acp/v2/user/usersubscription/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/usersubscription/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.removeUserSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#removeUserSubscription");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.removeUserSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#removeUserSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Remove User Subscription
[apiInstance removeUserSubscriptionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeUserSubscription(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Remove User Subscription
                oas_any_type_not_mapped result = apiInstance.removeUserSubscription();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.removeUserSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->removeUserSubscription();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->removeUserSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->removeUserSubscription();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->removeUserSubscription: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Remove User Subscription
    api_response = api_instance.remove_user_subscription()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->removeUserSubscription: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.removeUserSubscription(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


searchUserForModeration

Search User For Moderation

TODO


/api/acp/v2/user/list/notmoderator

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/list/notmoderator"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.searchUserForModeration();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#searchUserForModeration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.searchUserForModeration();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#searchUserForModeration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Search User For Moderation
[apiInstance searchUserForModerationWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchUserForModeration(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Search User For Moderation
                oas_any_type_not_mapped result = apiInstance.searchUserForModeration();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.searchUserForModeration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->searchUserForModeration();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->searchUserForModeration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->searchUserForModeration();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->searchUserForModeration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Search User For Moderation
    api_response = api_instance.search_user_for_moderation()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->searchUserForModeration: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.searchUserForModeration(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


signupACP

Signup

TODO


/api/acp/v2/user/create

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.signupACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#signupACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.signupACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#signupACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Signup
[apiInstance signupACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.signupACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Signup
                oas_any_type_not_mapped result = apiInstance.signupACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.signupACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->signupACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->signupACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->signupACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->signupACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Signup
    api_response = api_instance.signup_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->signupACP: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.signupACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateAdministrator

Update Administrator

TODO


/api/acp/v2/user/administrator/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/administrator/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateAdministrator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#updateAdministrator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateAdministrator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#updateAdministrator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Update Administrator
[apiInstance updateAdministratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAdministrator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Update Administrator
                oas_any_type_not_mapped result = apiInstance.updateAdministrator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.updateAdministrator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->updateAdministrator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->updateAdministrator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->updateAdministrator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->updateAdministrator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Update Administrator
    api_response = api_instance.update_administrator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->updateAdministrator: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.updateAdministrator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateUser

Update User

TODO


/api/acp/v2/user/edit

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#updateUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#updateUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Update User
[apiInstance updateUserWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUser(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Update User
                oas_any_type_not_mapped result = apiInstance.updateUser();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->updateUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->updateUser();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->updateUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Update User
    api_response = api_instance.update_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->updateUser: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.updateUser(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


uploadAvatarACP

Upload Avatar

TODO


/api/acp/v2/user/avatar/upload

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v2/user/avatar/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV2Api;

import java.io.File;
import java.util.*;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadAvatarACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#uploadAvatarACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV2Api;

public class ACPUserV2ApiExample {
    public static void main(String[] args) {
        ACPUserV2Api apiInstance = new ACPUserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadAvatarACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV2Api#uploadAvatarACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV2Api *apiInstance = [[ACPUserV2Api alloc] init];

// Upload Avatar
[apiInstance uploadAvatarACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadAvatarACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV2Api();

            try {
                // Upload Avatar
                oas_any_type_not_mapped result = apiInstance.uploadAvatarACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV2Api.uploadAvatarACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV2Api();

try {
    $result = $api_instance->uploadAvatarACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV2Api->uploadAvatarACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV2Api->new();

eval {
    my $result = $api_instance->uploadAvatarACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV2Api->uploadAvatarACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV2Api()

try:
    # Upload Avatar
    api_response = api_instance.upload_avatar_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV2Api->uploadAvatarACP: %s\n" % e)
extern crate ACPUserV2Api;

pub fn main() {

    let mut context = ACPUserV2Api::Context::default();
    let result = client.uploadAvatarACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ACPUserV3

getSubjectAccessData

Get Subject Access Data

TODO - Not used in Floatplane code.


/api/acp/v3/user/sar

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v3/user/sar"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV3Api;

import java.io.File;
import java.util.*;

public class ACPUserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV3Api apiInstance = new ACPUserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getSubjectAccessData();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV3Api#getSubjectAccessData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV3Api;

public class ACPUserV3ApiExample {
    public static void main(String[] args) {
        ACPUserV3Api apiInstance = new ACPUserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getSubjectAccessData();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV3Api#getSubjectAccessData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV3Api *apiInstance = [[ACPUserV3Api alloc] init];

// Get Subject Access Data
[apiInstance getSubjectAccessDataWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSubjectAccessData(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV3Api();

            try {
                // Get Subject Access Data
                oas_any_type_not_mapped result = apiInstance.getSubjectAccessData();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV3Api.getSubjectAccessData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV3Api();

try {
    $result = $api_instance->getSubjectAccessData();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV3Api->getSubjectAccessData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV3Api->new();

eval {
    my $result = $api_instance->getSubjectAccessData();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV3Api->getSubjectAccessData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV3Api()

try:
    # Get Subject Access Data
    api_response = api_instance.get_subject_access_data()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV3Api->getSubjectAccessData: %s\n" % e)
extern crate ACPUserV3Api;

pub fn main() {

    let mut context = ACPUserV3Api::Context::default();
    let result = client.getSubjectAccessData(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


scheduleDeletionACP

Schedule Deletion

TODO


/api/acp/v3/user/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v3/user/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV3Api;

import java.io.File;
import java.util.*;

public class ACPUserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV3Api apiInstance = new ACPUserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.scheduleDeletionACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV3Api#scheduleDeletionACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV3Api;

public class ACPUserV3ApiExample {
    public static void main(String[] args) {
        ACPUserV3Api apiInstance = new ACPUserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.scheduleDeletionACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV3Api#scheduleDeletionACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV3Api *apiInstance = [[ACPUserV3Api alloc] init];

// Schedule Deletion
[apiInstance scheduleDeletionACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.scheduleDeletionACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV3Api();

            try {
                // Schedule Deletion
                oas_any_type_not_mapped result = apiInstance.scheduleDeletionACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV3Api.scheduleDeletionACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV3Api();

try {
    $result = $api_instance->scheduleDeletionACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV3Api->scheduleDeletionACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV3Api->new();

eval {
    my $result = $api_instance->scheduleDeletionACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV3Api->scheduleDeletionACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV3Api()

try:
    # Schedule Deletion
    api_response = api_instance.schedule_deletion_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV3Api->scheduleDeletionACP: %s\n" % e)
extern crate ACPUserV3Api;

pub fn main() {

    let mut context = ACPUserV3Api::Context::default();
    let result = client.scheduleDeletionACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


unscheduleDeletionACP

Unschedule Deletion

TODO


/api/acp/v3/user/undelete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/acp/v3/user/undelete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserV3Api;

import java.io.File;
import java.util.*;

public class ACPUserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ACPUserV3Api apiInstance = new ACPUserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unscheduleDeletionACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV3Api#unscheduleDeletionACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserV3Api;

public class ACPUserV3ApiExample {
    public static void main(String[] args) {
        ACPUserV3Api apiInstance = new ACPUserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unscheduleDeletionACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserV3Api#unscheduleDeletionACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ACPUserV3Api *apiInstance = [[ACPUserV3Api alloc] init];

// Unschedule Deletion
[apiInstance unscheduleDeletionACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ACPUserV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unscheduleDeletionACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ACPUserV3Api();

            try {
                // Unschedule Deletion
                oas_any_type_not_mapped result = apiInstance.unscheduleDeletionACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserV3Api.unscheduleDeletionACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserV3Api();

try {
    $result = $api_instance->unscheduleDeletionACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserV3Api->unscheduleDeletionACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserV3Api->new();

eval {
    my $result = $api_instance->unscheduleDeletionACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserV3Api->unscheduleDeletionACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserV3Api()

try:
    # Unschedule Deletion
    api_response = api_instance.unschedule_deletion_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserV3Api->unscheduleDeletionACP: %s\n" % e)
extern crate ACPUserV3Api;

pub fn main() {

    let mut context = ACPUserV3Api::Context::default();
    let result = client.unscheduleDeletionACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ActivationV2

confirmEmail

Confirm Email

TODO


/api/v2/activation/email/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/activation/email/confirm"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActivationV2Api;

import java.io.File;
import java.util.*;

public class ActivationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ActivationV2Api apiInstance = new ActivationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.confirmEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivationV2Api#confirmEmail");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActivationV2Api;

public class ActivationV2ApiExample {
    public static void main(String[] args) {
        ActivationV2Api apiInstance = new ActivationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.confirmEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivationV2Api#confirmEmail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ActivationV2Api *apiInstance = [[ActivationV2Api alloc] init];

// Confirm Email
[apiInstance confirmEmailWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ActivationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmEmail(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ActivationV2Api();

            try {
                // Confirm Email
                oas_any_type_not_mapped result = apiInstance.confirmEmail();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActivationV2Api.confirmEmail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ActivationV2Api();

try {
    $result = $api_instance->confirmEmail();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivationV2Api->confirmEmail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ActivationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ActivationV2Api->new();

eval {
    my $result = $api_instance->confirmEmail();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActivationV2Api->confirmEmail: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ActivationV2Api()

try:
    # Confirm Email
    api_response = api_instance.confirm_email()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActivationV2Api->confirmEmail: %s\n" % e)
extern crate ActivationV2Api;

pub fn main() {

    let mut context = ActivationV2Api::Context::default();
    let result = client.confirmEmail(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


requestActivationEmail

Request Activation Email

TODO


/api/v2/activation/email/request

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/activation/email/request"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActivationV2Api;

import java.io.File;
import java.util.*;

public class ActivationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ActivationV2Api apiInstance = new ActivationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.requestActivationEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivationV2Api#requestActivationEmail");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActivationV2Api;

public class ActivationV2ApiExample {
    public static void main(String[] args) {
        ActivationV2Api apiInstance = new ActivationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.requestActivationEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivationV2Api#requestActivationEmail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ActivationV2Api *apiInstance = [[ActivationV2Api alloc] init];

// Request Activation Email
[apiInstance requestActivationEmailWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ActivationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.requestActivationEmail(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ActivationV2Api();

            try {
                // Request Activation Email
                oas_any_type_not_mapped result = apiInstance.requestActivationEmail();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActivationV2Api.requestActivationEmail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ActivationV2Api();

try {
    $result = $api_instance->requestActivationEmail();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivationV2Api->requestActivationEmail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ActivationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ActivationV2Api->new();

eval {
    my $result = $api_instance->requestActivationEmail();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActivationV2Api->requestActivationEmail: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ActivationV2Api()

try:
    # Request Activation Email
    api_response = api_instance.request_activation_email()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActivationV2Api->requestActivationEmail: %s\n" % e)
extern crate ActivationV2Api;

pub fn main() {

    let mut context = ActivationV2Api::Context::default();
    let result = client.requestActivationEmail(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


AdministrationV2

addGlobalModerator

Add Global Moderator

TODO - Not used in Floatplane code.


/api/v2/administration/moderators/global/add

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/administration/moderators/global/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdministrationV2Api;

import java.io.File;
import java.util.*;

public class AdministrationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AdministrationV2Api apiInstance = new AdministrationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationV2Api#addGlobalModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AdministrationV2Api;

public class AdministrationV2ApiExample {
    public static void main(String[] args) {
        AdministrationV2Api apiInstance = new AdministrationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationV2Api#addGlobalModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
AdministrationV2Api *apiInstance = [[AdministrationV2Api alloc] init];

// Add Global Moderator
[apiInstance addGlobalModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AdministrationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addGlobalModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AdministrationV2Api();

            try {
                // Add Global Moderator
                oas_any_type_not_mapped result = apiInstance.addGlobalModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdministrationV2Api.addGlobalModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdministrationV2Api();

try {
    $result = $api_instance->addGlobalModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationV2Api->addGlobalModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdministrationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdministrationV2Api->new();

eval {
    my $result = $api_instance->addGlobalModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdministrationV2Api->addGlobalModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AdministrationV2Api()

try:
    # Add Global Moderator
    api_response = api_instance.add_global_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationV2Api->addGlobalModerator: %s\n" % e)
extern crate AdministrationV2Api;

pub fn main() {

    let mut context = AdministrationV2Api::Context::default();
    let result = client.addGlobalModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getModerator

Get Moderator

TODO - Not used in Floatplane code.


/api/v2/administration/moderators/get/{user}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/administration/moderators/get/{user}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdministrationV2Api;

import java.io.File;
import java.util.*;

public class AdministrationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AdministrationV2Api apiInstance = new AdministrationV2Api();
        String user = user_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.getModerator(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationV2Api#getModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AdministrationV2Api;

public class AdministrationV2ApiExample {
    public static void main(String[] args) {
        AdministrationV2Api apiInstance = new AdministrationV2Api();
        String user = user_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.getModerator(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationV2Api#getModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
AdministrationV2Api *apiInstance = [[AdministrationV2Api alloc] init];
String *user = user_example; //  (default to null)

// Get Moderator
[apiInstance getModeratorWith:user
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AdministrationV2Api()
var user = user_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModerator(user, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AdministrationV2Api();
            var user = user_example;  // String |  (default to null)

            try {
                // Get Moderator
                oas_any_type_not_mapped result = apiInstance.getModerator(user);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdministrationV2Api.getModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdministrationV2Api();
$user = user_example; // String | 

try {
    $result = $api_instance->getModerator($user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationV2Api->getModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdministrationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdministrationV2Api->new();
my $user = user_example; # String | 

eval {
    my $result = $api_instance->getModerator(user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdministrationV2Api->getModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AdministrationV2Api()
user = user_example # String |  (default to null)

try:
    # Get Moderator
    api_response = api_instance.get_moderator(user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationV2Api->getModerator: %s\n" % e)
extern crate AdministrationV2Api;

pub fn main() {
    let user = user_example; // String

    let mut context = AdministrationV2Api::Context::default();
    let result = client.getModerator(user, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
user*
String
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listModeratorsAdmin

List Moderators

TODO - Not used in Floatplane code.


/api/v2/administration/moderators/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/administration/moderators/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdministrationV2Api;

import java.io.File;
import java.util.*;

public class AdministrationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AdministrationV2Api apiInstance = new AdministrationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listModeratorsAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationV2Api#listModeratorsAdmin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AdministrationV2Api;

public class AdministrationV2ApiExample {
    public static void main(String[] args) {
        AdministrationV2Api apiInstance = new AdministrationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listModeratorsAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationV2Api#listModeratorsAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
AdministrationV2Api *apiInstance = [[AdministrationV2Api alloc] init];

// List Moderators
[apiInstance listModeratorsAdminWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AdministrationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModeratorsAdmin(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AdministrationV2Api();

            try {
                // List Moderators
                oas_any_type_not_mapped result = apiInstance.listModeratorsAdmin();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdministrationV2Api.listModeratorsAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdministrationV2Api();

try {
    $result = $api_instance->listModeratorsAdmin();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationV2Api->listModeratorsAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdministrationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdministrationV2Api->new();

eval {
    my $result = $api_instance->listModeratorsAdmin();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdministrationV2Api->listModeratorsAdmin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AdministrationV2Api()

try:
    # List Moderators
    api_response = api_instance.list_moderators_admin()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationV2Api->listModeratorsAdmin: %s\n" % e)
extern crate AdministrationV2Api;

pub fn main() {

    let mut context = AdministrationV2Api::Context::default();
    let result = client.listModeratorsAdmin(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


removeGlobalModerator

Remove Global Moderator

TODO - Not used in Floatplane code.


/api/v2/administration/moderators/global/remove

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/administration/moderators/global/remove"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdministrationV2Api;

import java.io.File;
import java.util.*;

public class AdministrationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AdministrationV2Api apiInstance = new AdministrationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.removeGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationV2Api#removeGlobalModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AdministrationV2Api;

public class AdministrationV2ApiExample {
    public static void main(String[] args) {
        AdministrationV2Api apiInstance = new AdministrationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.removeGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationV2Api#removeGlobalModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
AdministrationV2Api *apiInstance = [[AdministrationV2Api alloc] init];

// Remove Global Moderator
[apiInstance removeGlobalModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AdministrationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeGlobalModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AdministrationV2Api();

            try {
                // Remove Global Moderator
                oas_any_type_not_mapped result = apiInstance.removeGlobalModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdministrationV2Api.removeGlobalModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdministrationV2Api();

try {
    $result = $api_instance->removeGlobalModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationV2Api->removeGlobalModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdministrationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdministrationV2Api->new();

eval {
    my $result = $api_instance->removeGlobalModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdministrationV2Api->removeGlobalModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AdministrationV2Api()

try:
    # Remove Global Moderator
    api_response = api_instance.remove_global_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationV2Api->removeGlobalModerator: %s\n" % e)
extern crate AdministrationV2Api;

pub fn main() {

    let mut context = AdministrationV2Api::Context::default();
    let result = client.removeGlobalModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


removeModerator

Remove Moderator

TODO - Not used in Floatplane code.


/api/v2/administration/moderators/remove

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/administration/moderators/remove"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdministrationV2Api;

import java.io.File;
import java.util.*;

public class AdministrationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AdministrationV2Api apiInstance = new AdministrationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.removeModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationV2Api#removeModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AdministrationV2Api;

public class AdministrationV2ApiExample {
    public static void main(String[] args) {
        AdministrationV2Api apiInstance = new AdministrationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.removeModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationV2Api#removeModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
AdministrationV2Api *apiInstance = [[AdministrationV2Api alloc] init];

// Remove Moderator
[apiInstance removeModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AdministrationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AdministrationV2Api();

            try {
                // Remove Moderator
                oas_any_type_not_mapped result = apiInstance.removeModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdministrationV2Api.removeModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdministrationV2Api();

try {
    $result = $api_instance->removeModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationV2Api->removeModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdministrationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdministrationV2Api->new();

eval {
    my $result = $api_instance->removeModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdministrationV2Api->removeModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AdministrationV2Api()

try:
    # Remove Moderator
    api_response = api_instance.remove_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationV2Api->removeModerator: %s\n" % e)
extern crate AdministrationV2Api;

pub fn main() {

    let mut context = AdministrationV2Api::Context::default();
    let result = client.removeModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


AuthV2

beginSpoofing

Begin Spoofing

TODO


/api/v2/auth/spoof/begin

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/auth/spoof/begin"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthV2Api;

import java.io.File;
import java.util.*;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthV2Api apiInstance = new AuthV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.beginSpoofing();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#beginSpoofing");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthV2Api;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        AuthV2Api apiInstance = new AuthV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.beginSpoofing();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#beginSpoofing");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
AuthV2Api *apiInstance = [[AuthV2Api alloc] init];

// Begin Spoofing
[apiInstance beginSpoofingWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AuthV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.beginSpoofing(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AuthV2Api();

            try {
                // Begin Spoofing
                oas_any_type_not_mapped result = apiInstance.beginSpoofing();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthV2Api.beginSpoofing: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthV2Api();

try {
    $result = $api_instance->beginSpoofing();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthV2Api->beginSpoofing: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthV2Api->new();

eval {
    my $result = $api_instance->beginSpoofing();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthV2Api->beginSpoofing: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthV2Api()

try:
    # Begin Spoofing
    api_response = api_instance.begin_spoofing()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthV2Api->beginSpoofing: %s\n" % e)
extern crate AuthV2Api;

pub fn main() {

    let mut context = AuthV2Api::Context::default();
    let result = client.beginSpoofing(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


checkFor2faLogin

Check For 2FA Login

Complete the login process if a two-factor authentication token is required from the beginning of the login process.


/api/v2/auth/checkFor2faLogin

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v2/auth/checkFor2faLogin" \
 -d '{
  "token" : "token"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthV2Api;

import java.io.File;
import java.util.*;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthV2Api apiInstance = new AuthV2Api();
        CheckFor2faLoginRequest checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest | 

        try {
            AuthLoginV2Response result = apiInstance.checkFor2faLogin(checkFor2faLoginRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#checkFor2faLogin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthV2Api;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        AuthV2Api apiInstance = new AuthV2Api();
        CheckFor2faLoginRequest checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest | 

        try {
            AuthLoginV2Response result = apiInstance.checkFor2faLogin(checkFor2faLoginRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#checkFor2faLogin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
AuthV2Api *apiInstance = [[AuthV2Api alloc] init];
CheckFor2faLoginRequest *checkFor2faLoginRequest = {"token":"123456"}; // 

// Check For 2FA Login
[apiInstance checkFor2faLoginWith:checkFor2faLoginRequest
              completionHandler: ^(AuthLoginV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AuthV2Api()
var checkFor2faLoginRequest = {"token":"123456"}; // {CheckFor2faLoginRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkFor2faLogin(checkFor2faLoginRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AuthV2Api();
            var checkFor2faLoginRequest = new CheckFor2faLoginRequest(); // CheckFor2faLoginRequest | 

            try {
                // Check For 2FA Login
                AuthLoginV2Response result = apiInstance.checkFor2faLogin(checkFor2faLoginRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthV2Api.checkFor2faLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthV2Api();
$checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest | 

try {
    $result = $api_instance->checkFor2faLogin($checkFor2faLoginRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthV2Api->checkFor2faLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthV2Api->new();
my $checkFor2faLoginRequest = WWW::OPenAPIClient::Object::CheckFor2faLoginRequest->new(); # CheckFor2faLoginRequest | 

eval {
    my $result = $api_instance->checkFor2faLogin(checkFor2faLoginRequest => $checkFor2faLoginRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthV2Api->checkFor2faLogin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthV2Api()
checkFor2faLoginRequest = {"token":"123456"} # CheckFor2faLoginRequest | 

try:
    # Check For 2FA Login
    api_response = api_instance.check_for2fa_login(checkFor2faLoginRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthV2Api->checkFor2faLogin: %s\n" % e)
extern crate AuthV2Api;

pub fn main() {
    let checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest

    let mut context = AuthV2Api::Context::default();
    let result = client.checkFor2faLogin(checkFor2faLoginRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
checkFor2faLoginRequest *

Responses

Name Type Format Description
SetMinusCookie String Contains the cookie used in subsequent authenticated requests.

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


endSpoofing

End Spoofing

TODO


/api/v2/auth/spoof/end

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/auth/spoof/end"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthV2Api;

import java.io.File;
import java.util.*;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthV2Api apiInstance = new AuthV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.endSpoofing();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#endSpoofing");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthV2Api;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        AuthV2Api apiInstance = new AuthV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.endSpoofing();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#endSpoofing");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
AuthV2Api *apiInstance = [[AuthV2Api alloc] init];

// End Spoofing
[apiInstance endSpoofingWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AuthV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endSpoofing(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AuthV2Api();

            try {
                // End Spoofing
                oas_any_type_not_mapped result = apiInstance.endSpoofing();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthV2Api.endSpoofing: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthV2Api();

try {
    $result = $api_instance->endSpoofing();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthV2Api->endSpoofing: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthV2Api->new();

eval {
    my $result = $api_instance->endSpoofing();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthV2Api->endSpoofing: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthV2Api()

try:
    # End Spoofing
    api_response = api_instance.end_spoofing()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthV2Api->endSpoofing: %s\n" % e)
extern crate AuthV2Api;

pub fn main() {

    let mut context = AuthV2Api::Context::default();
    let result = client.endSpoofing(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


login

Login

Login to Floatplane with the provided username and password, retrieving the authentication/authorization cookie from the response for subsequent requests.


/api/v2/auth/login

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v2/auth/login" \
 -d '{
  "password" : "password",
  "captchaToken" : "captchaToken",
  "username" : "username"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthV2Api;

import java.io.File;
import java.util.*;

public class AuthV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AuthV2Api apiInstance = new AuthV2Api();
        AuthLoginV2Request authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request | 

        try {
            AuthLoginV2Response result = apiInstance.login(authLoginV2Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#login");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthV2Api;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        AuthV2Api apiInstance = new AuthV2Api();
        AuthLoginV2Request authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request | 

        try {
            AuthLoginV2Response result = apiInstance.login(authLoginV2Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#login");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthV2Api *apiInstance = [[AuthV2Api alloc] init];
AuthLoginV2Request *authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // 

// Login
[apiInstance loginWith:authLoginV2Request
              completionHandler: ^(AuthLoginV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');

// Create an instance of the API class
var api = new FloatplaneRestApi.AuthV2Api()
var authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // {AuthLoginV2Request} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.login(authLoginV2Request, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class loginExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new AuthV2Api();
            var authLoginV2Request = new AuthLoginV2Request(); // AuthLoginV2Request | 

            try {
                // Login
                AuthLoginV2Response result = apiInstance.login(authLoginV2Request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthV2Api.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthV2Api();
$authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request | 

try {
    $result = $api_instance->login($authLoginV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthV2Api->login: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthV2Api;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthV2Api->new();
my $authLoginV2Request = WWW::OPenAPIClient::Object::AuthLoginV2Request->new(); # AuthLoginV2Request | 

eval {
    my $result = $api_instance->login(authLoginV2Request => $authLoginV2Request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthV2Api->login: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AuthV2Api()
authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."} # AuthLoginV2Request | 

try:
    # Login
    api_response = api_instance.login(authLoginV2Request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthV2Api->login: %s\n" % e)
extern crate AuthV2Api;

pub fn main() {
    let authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request

    let mut context = AuthV2Api::Context::default();
    let result = client.login(authLoginV2Request, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
authLoginV2Request *

Responses

Name Type Format Description
SetMinusCookie String Contains the cookie used in subsequent authenticated requests.

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


logout

Logout

Log out of Floatplane, invalidating the authentication/authorization cookie.


/api/v2/auth/logout

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: text/plain,application/json,text/html" \
 "https://www.floatplane.com/api/v2/auth/logout"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthV2Api;

import java.io.File;
import java.util.*;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthV2Api apiInstance = new AuthV2Api();

        try {
            'String' result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#logout");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthV2Api;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        AuthV2Api apiInstance = new AuthV2Api();

        try {
            'String' result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#logout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
AuthV2Api *apiInstance = [[AuthV2Api alloc] init];

// Logout
[apiInstance logoutWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AuthV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.logout(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AuthV2Api();

            try {
                // Logout
                'String' result = apiInstance.logout();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthV2Api.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthV2Api();

try {
    $result = $api_instance->logout();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthV2Api->logout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthV2Api->new();

eval {
    my $result = $api_instance->logout();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthV2Api->logout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthV2Api()

try:
    # Logout
    api_response = api_instance.logout()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthV2Api->logout: %s\n" % e)
extern crate AuthV2Api;

pub fn main() {

    let mut context = AuthV2Api::Context::default();
    let result = client.logout(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
SetMinusCookie String Contains the cookie used in subsequent authenticated requests.

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


signup

Signup

TODO


/api/v2/auth/signup

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/auth/signup"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthV2Api;

import java.io.File;
import java.util.*;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthV2Api apiInstance = new AuthV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.signup();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#signup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthV2Api;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        AuthV2Api apiInstance = new AuthV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.signup();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#signup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
AuthV2Api *apiInstance = [[AuthV2Api alloc] init];

// Signup
[apiInstance signupWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AuthV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.signup(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AuthV2Api();

            try {
                // Signup
                oas_any_type_not_mapped result = apiInstance.signup();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthV2Api.signup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthV2Api();

try {
    $result = $api_instance->signup();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthV2Api->signup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthV2Api->new();

eval {
    my $result = $api_instance->signup();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthV2Api->signup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthV2Api()

try:
    # Signup
    api_response = api_instance.signup()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthV2Api->signup: %s\n" % e)
extern crate AuthV2Api;

pub fn main() {

    let mut context = AuthV2Api::Context::default();
    let result = client.signup(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


AuthV3

getCaptchaInfo

Get Captcha Info

Gets the site keys used for Google Recaptcha V2 and V3. These are useful when providing a captcha token when logging in or signing up.


/api/v3/auth/captcha/info

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/auth/captcha/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthV3Api;

import java.io.File;
import java.util.*;

public class AuthV3ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AuthV3Api apiInstance = new AuthV3Api();

        try {
            GetCaptchaInfoResponse result = apiInstance.getCaptchaInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV3Api#getCaptchaInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthV3Api;

public class AuthV3ApiExample {
    public static void main(String[] args) {
        AuthV3Api apiInstance = new AuthV3Api();

        try {
            GetCaptchaInfoResponse result = apiInstance.getCaptchaInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV3Api#getCaptchaInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthV3Api *apiInstance = [[AuthV3Api alloc] init];

// Get Captcha Info
[apiInstance getCaptchaInfoWithCompletionHandler: 
              ^(GetCaptchaInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');

// Create an instance of the API class
var api = new FloatplaneRestApi.AuthV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaptchaInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCaptchaInfoExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new AuthV3Api();

            try {
                // Get Captcha Info
                GetCaptchaInfoResponse result = apiInstance.getCaptchaInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthV3Api.getCaptchaInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthV3Api();

try {
    $result = $api_instance->getCaptchaInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthV3Api->getCaptchaInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthV3Api;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthV3Api->new();

eval {
    my $result = $api_instance->getCaptchaInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthV3Api->getCaptchaInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AuthV3Api()

try:
    # Get Captcha Info
    api_response = api_instance.get_captcha_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthV3Api->getCaptchaInfo: %s\n" % e)
extern crate AuthV3Api;

pub fn main() {

    let mut context = AuthV3Api::Context::default();
    let result = client.getCaptchaInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


BrainTreeV2

generateClientToken

Generate Client Token

TODO


/api/v2/payment/braintree/token

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/braintree/token"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BrainTreeV2Api;

import java.io.File;
import java.util.*;

public class BrainTreeV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BrainTreeV2Api apiInstance = new BrainTreeV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.generateClientToken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrainTreeV2Api#generateClientToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BrainTreeV2Api;

public class BrainTreeV2ApiExample {
    public static void main(String[] args) {
        BrainTreeV2Api apiInstance = new BrainTreeV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.generateClientToken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrainTreeV2Api#generateClientToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
BrainTreeV2Api *apiInstance = [[BrainTreeV2Api alloc] init];

// Generate Client Token
[apiInstance generateClientTokenWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.BrainTreeV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateClientToken(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new BrainTreeV2Api();

            try {
                // Generate Client Token
                oas_any_type_not_mapped result = apiInstance.generateClientToken();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BrainTreeV2Api.generateClientToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BrainTreeV2Api();

try {
    $result = $api_instance->generateClientToken();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrainTreeV2Api->generateClientToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BrainTreeV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BrainTreeV2Api->new();

eval {
    my $result = $api_instance->generateClientToken();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrainTreeV2Api->generateClientToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.BrainTreeV2Api()

try:
    # Generate Client Token
    api_response = api_instance.generate_client_token()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrainTreeV2Api->generateClientToken: %s\n" % e)
extern crate BrainTreeV2Api;

pub fn main() {

    let mut context = BrainTreeV2Api::Context::default();
    let result = client.generateClientToken(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CDNV2

getDeliveryInfo

Get Delivery Info

Given an video/audio attachment identifier, retrieves the information necessary to play, download, or livestream the video/audio at various quality levels.


/api/v2/cdn/delivery

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/cdn/delivery?type=type_example&guid=guid_example&creator=creator_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CDNV2Api;

import java.io.File;
import java.util.*;

public class CDNV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CDNV2Api apiInstance = new CDNV2Api();
        String type = type_example; // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
        String guid = guid_example; // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
        String creator = creator_example; // String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.

        try {
            CdnDeliveryV2Response result = apiInstance.getDeliveryInfo(type, guid, creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CDNV2Api#getDeliveryInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CDNV2Api;

public class CDNV2ApiExample {
    public static void main(String[] args) {
        CDNV2Api apiInstance = new CDNV2Api();
        String type = type_example; // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
        String guid = guid_example; // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
        String creator = creator_example; // String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.

        try {
            CdnDeliveryV2Response result = apiInstance.getDeliveryInfo(type, guid, creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CDNV2Api#getDeliveryInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CDNV2Api *apiInstance = [[CDNV2Api alloc] init];
String *type = type_example; // Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later. (default to null)
String *guid = guid_example; // The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied. (optional) (default to null)
String *creator = creator_example; // The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned. (optional) (default to null)

// Get Delivery Info
[apiInstance getDeliveryInfoWith:type
    guid:guid
    creator:creator
              completionHandler: ^(CdnDeliveryV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CDNV2Api()
var type = type_example; // {String} Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
var opts = {
  'guid': guid_example, // {String} The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
  'creator': creator_example // {String} The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeliveryInfo(type, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CDNV2Api();
            var type = type_example;  // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later. (default to null)
            var guid = guid_example;  // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied. (optional)  (default to null)
            var creator = creator_example;  // String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned. (optional)  (default to null)

            try {
                // Get Delivery Info
                CdnDeliveryV2Response result = apiInstance.getDeliveryInfo(type, guid, creator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CDNV2Api.getDeliveryInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CDNV2Api();
$type = type_example; // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
$guid = guid_example; // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
$creator = creator_example; // String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.

try {
    $result = $api_instance->getDeliveryInfo($type, $guid, $creator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CDNV2Api->getDeliveryInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CDNV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CDNV2Api->new();
my $type = type_example; # String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
my $guid = guid_example; # String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
my $creator = creator_example; # String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.

eval {
    my $result = $api_instance->getDeliveryInfo(type => $type, guid => $guid, creator => $creator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CDNV2Api->getDeliveryInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CDNV2Api()
type = type_example # String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later. (default to null)
guid = guid_example # String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied. (optional) (default to null)
creator = creator_example # String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned. (optional) (default to null)

try:
    # Get Delivery Info
    api_response = api_instance.get_delivery_info(type, guid=guid, creator=creator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CDNV2Api->getDeliveryInfo: %s\n" % e)
extern crate CDNV2Api;

pub fn main() {
    let type = type_example; // String
    let guid = guid_example; // String
    let creator = creator_example; // String

    let mut context = CDNV2Api::Context::default();
    let result = client.getDeliveryInfo(type, guid, creator, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
type*
String
Used to determine which kind of retrieval method is requested for the video. - VOD = stream a Video On Demand - AOD = stream Audio On Demand - Live = Livestream the content - Download = Download the content for the user to play later.
Required
guid
String
The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
creator
String
The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CMSBlogPostV3

createBlogPost

Create Blog Post

TODO


/api/cms/v3/blogPost/create

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/blogPost/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostV3Api;

import java.io.File;
import java.util.*;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#createBlogPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostV3Api;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#createBlogPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSBlogPostV3Api *apiInstance = [[CMSBlogPostV3Api alloc] init];

// Create Blog Post
[apiInstance createBlogPostWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSBlogPostV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createBlogPost(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSBlogPostV3Api();

            try {
                // Create Blog Post
                oas_any_type_not_mapped result = apiInstance.createBlogPost();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostV3Api.createBlogPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostV3Api();

try {
    $result = $api_instance->createBlogPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostV3Api->createBlogPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostV3Api->new();

eval {
    my $result = $api_instance->createBlogPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostV3Api->createBlogPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostV3Api()

try:
    # Create Blog Post
    api_response = api_instance.create_blog_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostV3Api->createBlogPost: %s\n" % e)
extern crate CMSBlogPostV3Api;

pub fn main() {

    let mut context = CMSBlogPostV3Api::Context::default();
    let result = client.createBlogPost(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


deleteBlogPost

Delete Blog Post

TODO


/api/cms/v3/blogPost/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/blogPost/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostV3Api;

import java.io.File;
import java.util.*;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#deleteBlogPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostV3Api;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#deleteBlogPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSBlogPostV3Api *apiInstance = [[CMSBlogPostV3Api alloc] init];

// Delete Blog Post
[apiInstance deleteBlogPostWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSBlogPostV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteBlogPost(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSBlogPostV3Api();

            try {
                // Delete Blog Post
                oas_any_type_not_mapped result = apiInstance.deleteBlogPost();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostV3Api.deleteBlogPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostV3Api();

try {
    $result = $api_instance->deleteBlogPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostV3Api->deleteBlogPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostV3Api->new();

eval {
    my $result = $api_instance->deleteBlogPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostV3Api->deleteBlogPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostV3Api()

try:
    # Delete Blog Post
    api_response = api_instance.delete_blog_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostV3Api->deleteBlogPost: %s\n" % e)
extern crate CMSBlogPostV3Api;

pub fn main() {

    let mut context = CMSBlogPostV3Api::Context::default();
    let result = client.deleteBlogPost(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


editBlogPost

Edit Blog Post

TODO


/api/cms/v3/blogPost/edit

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/blogPost/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostV3Api;

import java.io.File;
import java.util.*;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.editBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#editBlogPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostV3Api;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.editBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#editBlogPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSBlogPostV3Api *apiInstance = [[CMSBlogPostV3Api alloc] init];

// Edit Blog Post
[apiInstance editBlogPostWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSBlogPostV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editBlogPost(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSBlogPostV3Api();

            try {
                // Edit Blog Post
                oas_any_type_not_mapped result = apiInstance.editBlogPost();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostV3Api.editBlogPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostV3Api();

try {
    $result = $api_instance->editBlogPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostV3Api->editBlogPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostV3Api->new();

eval {
    my $result = $api_instance->editBlogPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostV3Api->editBlogPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostV3Api()

try:
    # Edit Blog Post
    api_response = api_instance.edit_blog_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostV3Api->editBlogPost: %s\n" % e)
extern crate CMSBlogPostV3Api;

pub fn main() {

    let mut context = CMSBlogPostV3Api::Context::default();
    let result = client.editBlogPost(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getBlogPostCMS

Get Blog Post

TODO


/api/cms/v3/blogPost/get

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/blogPost/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostV3Api;

import java.io.File;
import java.util.*;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getBlogPostCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#getBlogPostCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostV3Api;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getBlogPostCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#getBlogPostCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSBlogPostV3Api *apiInstance = [[CMSBlogPostV3Api alloc] init];

// Get Blog Post
[apiInstance getBlogPostCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSBlogPostV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBlogPostCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSBlogPostV3Api();

            try {
                // Get Blog Post
                oas_any_type_not_mapped result = apiInstance.getBlogPostCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostV3Api.getBlogPostCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostV3Api();

try {
    $result = $api_instance->getBlogPostCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostV3Api->getBlogPostCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostV3Api->new();

eval {
    my $result = $api_instance->getBlogPostCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostV3Api->getBlogPostCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostV3Api()

try:
    # Get Blog Post
    api_response = api_instance.get_blog_post_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostV3Api->getBlogPostCMS: %s\n" % e)
extern crate CMSBlogPostV3Api;

pub fn main() {

    let mut context = CMSBlogPostV3Api::Context::default();
    let result = client.getBlogPostCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listBlogPost

List Blog Post

TODO


/api/cms/v3/blogPost/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/blogPost/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostV3Api;

import java.io.File;
import java.util.*;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#listBlogPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostV3Api;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#listBlogPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSBlogPostV3Api *apiInstance = [[CMSBlogPostV3Api alloc] init];

// List Blog Post
[apiInstance listBlogPostWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSBlogPostV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listBlogPost(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSBlogPostV3Api();

            try {
                // List Blog Post
                oas_any_type_not_mapped result = apiInstance.listBlogPost();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostV3Api.listBlogPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostV3Api();

try {
    $result = $api_instance->listBlogPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostV3Api->listBlogPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostV3Api->new();

eval {
    my $result = $api_instance->listBlogPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostV3Api->listBlogPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostV3Api()

try:
    # List Blog Post
    api_response = api_instance.list_blog_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostV3Api->listBlogPost: %s\n" % e)
extern crate CMSBlogPostV3Api;

pub fn main() {

    let mut context = CMSBlogPostV3Api::Context::default();
    let result = client.listBlogPost(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateNewAttachments

Update New Attachments

TODO


/api/cms/v3/blogPost/attachments/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/blogPost/attachments/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostV3Api;

import java.io.File;
import java.util.*;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateNewAttachments();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#updateNewAttachments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostV3Api;

public class CMSBlogPostV3ApiExample {
    public static void main(String[] args) {
        CMSBlogPostV3Api apiInstance = new CMSBlogPostV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateNewAttachments();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostV3Api#updateNewAttachments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSBlogPostV3Api *apiInstance = [[CMSBlogPostV3Api alloc] init];

// Update New Attachments
[apiInstance updateNewAttachmentsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSBlogPostV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateNewAttachments(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSBlogPostV3Api();

            try {
                // Update New Attachments
                oas_any_type_not_mapped result = apiInstance.updateNewAttachments();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostV3Api.updateNewAttachments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostV3Api();

try {
    $result = $api_instance->updateNewAttachments();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostV3Api->updateNewAttachments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostV3Api->new();

eval {
    my $result = $api_instance->updateNewAttachments();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostV3Api->updateNewAttachments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostV3Api()

try:
    # Update New Attachments
    api_response = api_instance.update_new_attachments()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostV3Api->updateNewAttachments: %s\n" % e)
extern crate CMSBlogPostV3Api;

pub fn main() {

    let mut context = CMSBlogPostV3Api::Context::default();
    let result = client.updateNewAttachments(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CMSContentV3

deleteContent

Delete Content

TODO


/api/cms/v3/content/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/content/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentV3Api;

import java.io.File;
import java.util.*;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#deleteContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentV3Api;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#deleteContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSContentV3Api *apiInstance = [[CMSContentV3Api alloc] init];

// Delete Content
[apiInstance deleteContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSContentV3Api();

            try {
                // Delete Content
                oas_any_type_not_mapped result = apiInstance.deleteContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentV3Api.deleteContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentV3Api();

try {
    $result = $api_instance->deleteContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentV3Api->deleteContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentV3Api->new();

eval {
    my $result = $api_instance->deleteContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentV3Api->deleteContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentV3Api()

try:
    # Delete Content
    api_response = api_instance.delete_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentV3Api->deleteContent: %s\n" % e)
extern crate CMSContentV3Api;

pub fn main() {

    let mut context = CMSContentV3Api::Context::default();
    let result = client.deleteContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


editContent

Edit Content

TODO


/api/cms/v3/content/edit

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/content/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentV3Api;

import java.io.File;
import java.util.*;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.editContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#editContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentV3Api;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.editContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#editContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSContentV3Api *apiInstance = [[CMSContentV3Api alloc] init];

// Edit Content
[apiInstance editContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSContentV3Api();

            try {
                // Edit Content
                oas_any_type_not_mapped result = apiInstance.editContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentV3Api.editContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentV3Api();

try {
    $result = $api_instance->editContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentV3Api->editContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentV3Api->new();

eval {
    my $result = $api_instance->editContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentV3Api->editContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentV3Api()

try:
    # Edit Content
    api_response = api_instance.edit_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentV3Api->editContent: %s\n" % e)
extern crate CMSContentV3Api;

pub fn main() {

    let mut context = CMSContentV3Api::Context::default();
    let result = client.editContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getAudioContentCMS

Get Audio Content

TODO


/api/cms/v3/content/audio/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/content/audio/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentV3Api;

import java.io.File;
import java.util.*;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAudioContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#getAudioContentCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentV3Api;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAudioContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#getAudioContentCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSContentV3Api *apiInstance = [[CMSContentV3Api alloc] init];

// Get Audio Content
[apiInstance getAudioContentCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAudioContentCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSContentV3Api();

            try {
                // Get Audio Content
                oas_any_type_not_mapped result = apiInstance.getAudioContentCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentV3Api.getAudioContentCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentV3Api();

try {
    $result = $api_instance->getAudioContentCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentV3Api->getAudioContentCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentV3Api->new();

eval {
    my $result = $api_instance->getAudioContentCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentV3Api->getAudioContentCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentV3Api()

try:
    # Get Audio Content
    api_response = api_instance.get_audio_content_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentV3Api->getAudioContentCMS: %s\n" % e)
extern crate CMSContentV3Api;

pub fn main() {

    let mut context = CMSContentV3Api::Context::default();
    let result = client.getAudioContentCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getContentCMS

Get Content

TODO - Not used in Floatplane code.


/api/cms/v3/content/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/content/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentV3Api;

import java.io.File;
import java.util.*;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#getContentCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentV3Api;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#getContentCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSContentV3Api *apiInstance = [[CMSContentV3Api alloc] init];

// Get Content
[apiInstance getContentCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContentCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSContentV3Api();

            try {
                // Get Content
                oas_any_type_not_mapped result = apiInstance.getContentCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentV3Api.getContentCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentV3Api();

try {
    $result = $api_instance->getContentCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentV3Api->getContentCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentV3Api->new();

eval {
    my $result = $api_instance->getContentCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentV3Api->getContentCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentV3Api()

try:
    # Get Content
    api_response = api_instance.get_content_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentV3Api->getContentCMS: %s\n" % e)
extern crate CMSContentV3Api;

pub fn main() {

    let mut context = CMSContentV3Api::Context::default();
    let result = client.getContentCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getGalleryContentCMS

Get Gallery Content

TODO


/api/cms/v3/content/gallery/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/content/gallery/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentV3Api;

import java.io.File;
import java.util.*;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getGalleryContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#getGalleryContentCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentV3Api;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getGalleryContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#getGalleryContentCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSContentV3Api *apiInstance = [[CMSContentV3Api alloc] init];

// Get Gallery Content
[apiInstance getGalleryContentCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGalleryContentCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSContentV3Api();

            try {
                // Get Gallery Content
                oas_any_type_not_mapped result = apiInstance.getGalleryContentCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentV3Api.getGalleryContentCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentV3Api();

try {
    $result = $api_instance->getGalleryContentCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentV3Api->getGalleryContentCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentV3Api->new();

eval {
    my $result = $api_instance->getGalleryContentCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentV3Api->getGalleryContentCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentV3Api()

try:
    # Get Gallery Content
    api_response = api_instance.get_gallery_content_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentV3Api->getGalleryContentCMS: %s\n" % e)
extern crate CMSContentV3Api;

pub fn main() {

    let mut context = CMSContentV3Api::Context::default();
    let result = client.getGalleryContentCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getPictureContentCMS

Get Picture Content

TODO


/api/cms/v3/content/picture/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/content/picture/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentV3Api;

import java.io.File;
import java.util.*;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getPictureContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#getPictureContentCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentV3Api;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getPictureContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#getPictureContentCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSContentV3Api *apiInstance = [[CMSContentV3Api alloc] init];

// Get Picture Content
[apiInstance getPictureContentCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPictureContentCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSContentV3Api();

            try {
                // Get Picture Content
                oas_any_type_not_mapped result = apiInstance.getPictureContentCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentV3Api.getPictureContentCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentV3Api();

try {
    $result = $api_instance->getPictureContentCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentV3Api->getPictureContentCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentV3Api->new();

eval {
    my $result = $api_instance->getPictureContentCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentV3Api->getPictureContentCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentV3Api()

try:
    # Get Picture Content
    api_response = api_instance.get_picture_content_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentV3Api->getPictureContentCMS: %s\n" % e)
extern crate CMSContentV3Api;

pub fn main() {

    let mut context = CMSContentV3Api::Context::default();
    let result = client.getPictureContentCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getVideoContentCMS

Get Video Content

TODO


/api/cms/v3/content/video/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/content/video/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentV3Api;

import java.io.File;
import java.util.*;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getVideoContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#getVideoContentCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentV3Api;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getVideoContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#getVideoContentCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSContentV3Api *apiInstance = [[CMSContentV3Api alloc] init];

// Get Video Content
[apiInstance getVideoContentCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoContentCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSContentV3Api();

            try {
                // Get Video Content
                oas_any_type_not_mapped result = apiInstance.getVideoContentCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentV3Api.getVideoContentCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentV3Api();

try {
    $result = $api_instance->getVideoContentCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentV3Api->getVideoContentCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentV3Api->new();

eval {
    my $result = $api_instance->getVideoContentCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentV3Api->getVideoContentCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentV3Api()

try:
    # Get Video Content
    api_response = api_instance.get_video_content_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentV3Api->getVideoContentCMS: %s\n" % e)
extern crate CMSContentV3Api;

pub fn main() {

    let mut context = CMSContentV3Api::Context::default();
    let result = client.getVideoContentCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listAudioContent

List Audio Content

TODO


/api/cms/v3/content/audio/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/content/audio/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentV3Api;

import java.io.File;
import java.util.*;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listAudioContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#listAudioContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentV3Api;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listAudioContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#listAudioContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSContentV3Api *apiInstance = [[CMSContentV3Api alloc] init];

// List Audio Content
[apiInstance listAudioContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAudioContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSContentV3Api();

            try {
                // List Audio Content
                oas_any_type_not_mapped result = apiInstance.listAudioContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentV3Api.listAudioContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentV3Api();

try {
    $result = $api_instance->listAudioContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentV3Api->listAudioContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentV3Api->new();

eval {
    my $result = $api_instance->listAudioContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentV3Api->listAudioContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentV3Api()

try:
    # List Audio Content
    api_response = api_instance.list_audio_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentV3Api->listAudioContent: %s\n" % e)
extern crate CMSContentV3Api;

pub fn main() {

    let mut context = CMSContentV3Api::Context::default();
    let result = client.listAudioContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listGalleryContent

List Gallery Content

TODO


/api/cms/v3/content/gallery/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/content/gallery/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentV3Api;

import java.io.File;
import java.util.*;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listGalleryContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#listGalleryContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentV3Api;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listGalleryContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#listGalleryContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSContentV3Api *apiInstance = [[CMSContentV3Api alloc] init];

// List Gallery Content
[apiInstance listGalleryContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listGalleryContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSContentV3Api();

            try {
                // List Gallery Content
                oas_any_type_not_mapped result = apiInstance.listGalleryContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentV3Api.listGalleryContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentV3Api();

try {
    $result = $api_instance->listGalleryContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentV3Api->listGalleryContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentV3Api->new();

eval {
    my $result = $api_instance->listGalleryContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentV3Api->listGalleryContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentV3Api()

try:
    # List Gallery Content
    api_response = api_instance.list_gallery_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentV3Api->listGalleryContent: %s\n" % e)
extern crate CMSContentV3Api;

pub fn main() {

    let mut context = CMSContentV3Api::Context::default();
    let result = client.listGalleryContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listPictureContent

List Picture Content

TODO


/api/cms/v3/content/picture/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/content/picture/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentV3Api;

import java.io.File;
import java.util.*;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listPictureContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#listPictureContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentV3Api;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listPictureContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#listPictureContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSContentV3Api *apiInstance = [[CMSContentV3Api alloc] init];

// List Picture Content
[apiInstance listPictureContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPictureContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSContentV3Api();

            try {
                // List Picture Content
                oas_any_type_not_mapped result = apiInstance.listPictureContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentV3Api.listPictureContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentV3Api();

try {
    $result = $api_instance->listPictureContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentV3Api->listPictureContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentV3Api->new();

eval {
    my $result = $api_instance->listPictureContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentV3Api->listPictureContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentV3Api()

try:
    # List Picture Content
    api_response = api_instance.list_picture_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentV3Api->listPictureContent: %s\n" % e)
extern crate CMSContentV3Api;

pub fn main() {

    let mut context = CMSContentV3Api::Context::default();
    let result = client.listPictureContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listVideoContent

List Video Content

TODO


/api/cms/v3/content/video/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/content/video/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentV3Api;

import java.io.File;
import java.util.*;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listVideoContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#listVideoContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentV3Api;

public class CMSContentV3ApiExample {
    public static void main(String[] args) {
        CMSContentV3Api apiInstance = new CMSContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listVideoContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentV3Api#listVideoContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSContentV3Api *apiInstance = [[CMSContentV3Api alloc] init];

// List Video Content
[apiInstance listVideoContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listVideoContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSContentV3Api();

            try {
                // List Video Content
                oas_any_type_not_mapped result = apiInstance.listVideoContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentV3Api.listVideoContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentV3Api();

try {
    $result = $api_instance->listVideoContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentV3Api->listVideoContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentV3Api->new();

eval {
    my $result = $api_instance->listVideoContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentV3Api->listVideoContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentV3Api()

try:
    # List Video Content
    api_response = api_instance.list_video_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentV3Api->listVideoContent: %s\n" % e)
extern crate CMSContentV3Api;

pub fn main() {

    let mut context = CMSContentV3Api::Context::default();
    let result = client.listVideoContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CMSCreatorSubscriptionPlanV3

downloadSubscribers

Download Subscribers

TODO


/api/cms/v3/subscribers/download

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/subscribers/download"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorSubscriptionPlanV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorSubscriptionPlanV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorSubscriptionPlanV3Api apiInstance = new CMSCreatorSubscriptionPlanV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.downloadSubscribers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanV3Api#downloadSubscribers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorSubscriptionPlanV3Api;

public class CMSCreatorSubscriptionPlanV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorSubscriptionPlanV3Api apiInstance = new CMSCreatorSubscriptionPlanV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.downloadSubscribers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanV3Api#downloadSubscribers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorSubscriptionPlanV3Api *apiInstance = [[CMSCreatorSubscriptionPlanV3Api alloc] init];

// Download Subscribers
[apiInstance downloadSubscribersWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorSubscriptionPlanV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadSubscribers(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorSubscriptionPlanV3Api();

            try {
                // Download Subscribers
                oas_any_type_not_mapped result = apiInstance.downloadSubscribers();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorSubscriptionPlanV3Api.downloadSubscribers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorSubscriptionPlanV3Api();

try {
    $result = $api_instance->downloadSubscribers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorSubscriptionPlanV3Api->downloadSubscribers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorSubscriptionPlanV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorSubscriptionPlanV3Api->new();

eval {
    my $result = $api_instance->downloadSubscribers();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorSubscriptionPlanV3Api->downloadSubscribers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorSubscriptionPlanV3Api()

try:
    # Download Subscribers
    api_response = api_instance.download_subscribers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorSubscriptionPlanV3Api->downloadSubscribers: %s\n" % e)
extern crate CMSCreatorSubscriptionPlanV3Api;

pub fn main() {

    let mut context = CMSCreatorSubscriptionPlanV3Api::Context::default();
    let result = client.downloadSubscribers(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listSubscribers

List Subscribers

TODO


/api/cms/v3/subscribers/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/subscribers/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorSubscriptionPlanV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorSubscriptionPlanV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorSubscriptionPlanV3Api apiInstance = new CMSCreatorSubscriptionPlanV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listSubscribers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanV3Api#listSubscribers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorSubscriptionPlanV3Api;

public class CMSCreatorSubscriptionPlanV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorSubscriptionPlanV3Api apiInstance = new CMSCreatorSubscriptionPlanV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listSubscribers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanV3Api#listSubscribers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorSubscriptionPlanV3Api *apiInstance = [[CMSCreatorSubscriptionPlanV3Api alloc] init];

// List Subscribers
[apiInstance listSubscribersWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorSubscriptionPlanV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSubscribers(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorSubscriptionPlanV3Api();

            try {
                // List Subscribers
                oas_any_type_not_mapped result = apiInstance.listSubscribers();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorSubscriptionPlanV3Api.listSubscribers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorSubscriptionPlanV3Api();

try {
    $result = $api_instance->listSubscribers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorSubscriptionPlanV3Api->listSubscribers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorSubscriptionPlanV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorSubscriptionPlanV3Api->new();

eval {
    my $result = $api_instance->listSubscribers();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorSubscriptionPlanV3Api->listSubscribers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorSubscriptionPlanV3Api()

try:
    # List Subscribers
    api_response = api_instance.list_subscribers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorSubscriptionPlanV3Api->listSubscribers: %s\n" % e)
extern crate CMSCreatorSubscriptionPlanV3Api;

pub fn main() {

    let mut context = CMSCreatorSubscriptionPlanV3Api::Context::default();
    let result = client.listSubscribers(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listSubscriptionPlansCMS

List Subscription Plans

TODO


/api/cms/v3/plan/list

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/plan/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorSubscriptionPlanV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorSubscriptionPlanV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorSubscriptionPlanV3Api apiInstance = new CMSCreatorSubscriptionPlanV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listSubscriptionPlansCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanV3Api#listSubscriptionPlansCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorSubscriptionPlanV3Api;

public class CMSCreatorSubscriptionPlanV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorSubscriptionPlanV3Api apiInstance = new CMSCreatorSubscriptionPlanV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listSubscriptionPlansCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanV3Api#listSubscriptionPlansCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorSubscriptionPlanV3Api *apiInstance = [[CMSCreatorSubscriptionPlanV3Api alloc] init];

// List Subscription Plans
[apiInstance listSubscriptionPlansCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorSubscriptionPlanV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSubscriptionPlansCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorSubscriptionPlanV3Api();

            try {
                // List Subscription Plans
                oas_any_type_not_mapped result = apiInstance.listSubscriptionPlansCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorSubscriptionPlanV3Api.listSubscriptionPlansCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorSubscriptionPlanV3Api();

try {
    $result = $api_instance->listSubscriptionPlansCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorSubscriptionPlanV3Api->listSubscriptionPlansCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorSubscriptionPlanV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorSubscriptionPlanV3Api->new();

eval {
    my $result = $api_instance->listSubscriptionPlansCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorSubscriptionPlanV3Api->listSubscriptionPlansCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorSubscriptionPlanV3Api()

try:
    # List Subscription Plans
    api_response = api_instance.list_subscription_plans_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorSubscriptionPlanV3Api->listSubscriptionPlansCMS: %s\n" % e)
extern crate CMSCreatorSubscriptionPlanV3Api;

pub fn main() {

    let mut context = CMSCreatorSubscriptionPlanV3Api::Context::default();
    let result = client.listSubscriptionPlansCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CMSCreatorWarehouseV3

createPriceRule

Create Price Rule

TODO


/api/cms/v3/creatorwarehouse/pricerule/create

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/pricerule/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#createPriceRule");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#createPriceRule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// Create Price Rule
[apiInstance createPriceRuleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPriceRule(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // Create Price Rule
                oas_any_type_not_mapped result = apiInstance.createPriceRule();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.createPriceRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->createPriceRule();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->createPriceRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->createPriceRule();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->createPriceRule: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # Create Price Rule
    api_response = api_instance.create_price_rule()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->createPriceRule: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.createPriceRule(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


deletePriceRule

Delete Price Rule

TODO


/api/cms/v3/creatorwarehouse/pricerule/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/pricerule/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deletePriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#deletePriceRule");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deletePriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#deletePriceRule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// Delete Price Rule
[apiInstance deletePriceRuleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePriceRule(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // Delete Price Rule
                oas_any_type_not_mapped result = apiInstance.deletePriceRule();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.deletePriceRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->deletePriceRule();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->deletePriceRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->deletePriceRule();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->deletePriceRule: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # Delete Price Rule
    api_response = api_instance.delete_price_rule()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->deletePriceRule: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.deletePriceRule(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


editPriceRule

Edit Price Rule

TODO


/api/cms/v3/creatorwarehouse/pricerule/edit

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/pricerule/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.editPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#editPriceRule");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.editPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#editPriceRule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// Edit Price Rule
[apiInstance editPriceRuleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editPriceRule(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // Edit Price Rule
                oas_any_type_not_mapped result = apiInstance.editPriceRule();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.editPriceRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->editPriceRule();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->editPriceRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->editPriceRule();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->editPriceRule: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # Edit Price Rule
    api_response = api_instance.edit_price_rule()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->editPriceRule: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.editPriceRule(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCollections

Get Collections

TODO


/api/cms/v3/creatorwarehouse/collections/get

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/collections/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCollections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getCollections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCollections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getCollections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// Get Collections
[apiInstance getCollectionsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCollections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // Get Collections
                oas_any_type_not_mapped result = apiInstance.getCollections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.getCollections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->getCollections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->getCollections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->getCollections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->getCollections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # Get Collections
    api_response = api_instance.get_collections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->getCollections: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.getCollections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCountries

Get Countries

TODO


/api/cms/v3/creatorwarehouse/countries/get

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/countries/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getCountries");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getCountries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// Get Countries
[apiInstance getCountriesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCountries(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // Get Countries
                oas_any_type_not_mapped result = apiInstance.getCountries();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.getCountries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->getCountries();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->getCountries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->getCountries();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->getCountries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # Get Countries
    api_response = api_instance.get_countries()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->getCountries: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.getCountries(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorWarehouse

Get Creator Warehouse

TODO


/api/cms/v3/creatorwarehouse

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorWarehouse();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getCreatorWarehouse");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorWarehouse();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getCreatorWarehouse");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// Get Creator Warehouse
[apiInstance getCreatorWarehouseWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorWarehouse(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // Get Creator Warehouse
                oas_any_type_not_mapped result = apiInstance.getCreatorWarehouse();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.getCreatorWarehouse: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->getCreatorWarehouse();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->getCreatorWarehouse: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->getCreatorWarehouse();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->getCreatorWarehouse: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # Get Creator Warehouse
    api_response = api_instance.get_creator_warehouse()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->getCreatorWarehouse: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.getCreatorWarehouse(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getPriceRule

Get Price Rule

TODO


/api/cms/v3/creatorwarehouse/pricerule/

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/pricerule/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getPriceRule");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getPriceRule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// Get Price Rule
[apiInstance getPriceRuleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPriceRule(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // Get Price Rule
                oas_any_type_not_mapped result = apiInstance.getPriceRule();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.getPriceRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->getPriceRule();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->getPriceRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->getPriceRule();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->getPriceRule: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # Get Price Rule
    api_response = api_instance.get_price_rule()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->getPriceRule: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.getPriceRule(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getProducts

Get Products

TODO


/api/cms/v3/creatorwarehouse/products/get

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/products/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getProducts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getProducts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getProducts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// Get Products
[apiInstance getProductsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProducts(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // Get Products
                oas_any_type_not_mapped result = apiInstance.getProducts();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.getProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->getProducts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->getProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->getProducts();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->getProducts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # Get Products
    api_response = api_instance.get_products()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->getProducts: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.getProducts(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getShopInfo

Get Shop Info

TODO


/api/cms/v3/creatorwarehouse/shop/get

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/shop/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getShopInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getShopInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getShopInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#getShopInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// Get Shop Info
[apiInstance getShopInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShopInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // Get Shop Info
                oas_any_type_not_mapped result = apiInstance.getShopInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.getShopInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->getShopInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->getShopInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->getShopInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->getShopInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # Get Shop Info
    api_response = api_instance.get_shop_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->getShopInfo: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.getShopInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listCollections

List Collections

TODO


/api/cms/v3/creatorwarehouse/collections/list

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/collections/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCollections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#listCollections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCollections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#listCollections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// List Collections
[apiInstance listCollectionsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCollections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // List Collections
                oas_any_type_not_mapped result = apiInstance.listCollections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.listCollections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->listCollections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->listCollections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->listCollections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->listCollections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # List Collections
    api_response = api_instance.list_collections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->listCollections: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.listCollections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listPriceRules

List Price Rules

TODO


/api/cms/v3/creatorwarehouse/pricerule/list

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/pricerule/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listPriceRules();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#listPriceRules");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listPriceRules();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#listPriceRules");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// List Price Rules
[apiInstance listPriceRulesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPriceRules(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // List Price Rules
                oas_any_type_not_mapped result = apiInstance.listPriceRules();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.listPriceRules: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->listPriceRules();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->listPriceRules: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->listPriceRules();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->listPriceRules: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # List Price Rules
    api_response = api_instance.list_price_rules()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->listPriceRules: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.listPriceRules(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listProducts

List Products

TODO


/api/cms/v3/creatorwarehouse/products/list

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/products/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listProducts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#listProducts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listProducts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#listProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// List Products
[apiInstance listProductsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProducts(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // List Products
                oas_any_type_not_mapped result = apiInstance.listProducts();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.listProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->listProducts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->listProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->listProducts();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->listProducts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # List Products
    api_response = api_instance.list_products()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->listProducts: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.listProducts(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listShopShippingCountries

List Shop Shipping Countries

TODO


/api/cms/v3/creatorwarehouse/shop/shippingcountries/list

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/shop/shippingcountries/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listShopShippingCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#listShopShippingCountries");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listShopShippingCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#listShopShippingCountries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// List Shop Shipping Countries
[apiInstance listShopShippingCountriesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listShopShippingCountries(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // List Shop Shipping Countries
                oas_any_type_not_mapped result = apiInstance.listShopShippingCountries();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.listShopShippingCountries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->listShopShippingCountries();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->listShopShippingCountries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->listShopShippingCountries();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->listShopShippingCountries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # List Shop Shipping Countries
    api_response = api_instance.list_shop_shipping_countries()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->listShopShippingCountries: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.listShopShippingCountries(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


saveCreatorWarehouse

Save Creator Warehouse

TODO


/api/cms/v3/creatorwarehouse/save

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveCreatorWarehouse();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#saveCreatorWarehouse");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseV3Api;

public class CMSCreatorWarehouseV3ApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseV3Api apiInstance = new CMSCreatorWarehouseV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.saveCreatorWarehouse();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseV3Api#saveCreatorWarehouse");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSCreatorWarehouseV3Api *apiInstance = [[CMSCreatorWarehouseV3Api alloc] init];

// Save Creator Warehouse
[apiInstance saveCreatorWarehouseWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSCreatorWarehouseV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveCreatorWarehouse(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseV3Api();

            try {
                // Save Creator Warehouse
                oas_any_type_not_mapped result = apiInstance.saveCreatorWarehouse();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseV3Api.saveCreatorWarehouse: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseV3Api();

try {
    $result = $api_instance->saveCreatorWarehouse();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseV3Api->saveCreatorWarehouse: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseV3Api->new();

eval {
    my $result = $api_instance->saveCreatorWarehouse();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseV3Api->saveCreatorWarehouse: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseV3Api()

try:
    # Save Creator Warehouse
    api_response = api_instance.save_creator_warehouse()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseV3Api->saveCreatorWarehouse: %s\n" % e)
extern crate CMSCreatorWarehouseV3Api;

pub fn main() {

    let mut context = CMSCreatorWarehouseV3Api::Context::default();
    let result = client.saveCreatorWarehouse(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CMSLivestreamV3

getLivestreamInfo

Get Livestream Info

TODO


/api/cms/v3/live/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/live/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSLivestreamV3Api;

import java.io.File;
import java.util.*;

public class CMSLivestreamV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CMSLivestreamV3Api apiInstance = new CMSLivestreamV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getLivestreamInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSLivestreamV3Api#getLivestreamInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSLivestreamV3Api;

public class CMSLivestreamV3ApiExample {
    public static void main(String[] args) {
        CMSLivestreamV3Api apiInstance = new CMSLivestreamV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getLivestreamInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSLivestreamV3Api#getLivestreamInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CMSLivestreamV3Api *apiInstance = [[CMSLivestreamV3Api alloc] init];

// Get Livestream Info
[apiInstance getLivestreamInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CMSLivestreamV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLivestreamInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CMSLivestreamV3Api();

            try {
                // Get Livestream Info
                oas_any_type_not_mapped result = apiInstance.getLivestreamInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSLivestreamV3Api.getLivestreamInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSLivestreamV3Api();

try {
    $result = $api_instance->getLivestreamInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSLivestreamV3Api->getLivestreamInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSLivestreamV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSLivestreamV3Api->new();

eval {
    my $result = $api_instance->getLivestreamInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSLivestreamV3Api->getLivestreamInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSLivestreamV3Api()

try:
    # Get Livestream Info
    api_response = api_instance.get_livestream_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSLivestreamV3Api->getLivestreamInfo: %s\n" % e)
extern crate CMSLivestreamV3Api;

pub fn main() {

    let mut context = CMSLivestreamV3Api::Context::default();
    let result = client.getLivestreamInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CommentV3

deleteComment

Delete Comment

TODO


/api/v3/comment/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/comment/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#deleteComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#deleteComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];

// Delete Comment
[apiInstance deleteCommentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteComment(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();

            try {
                // Delete Comment
                oas_any_type_not_mapped result = apiInstance.deleteComment();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.deleteComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();

try {
    $result = $api_instance->deleteComment();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->deleteComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();

eval {
    my $result = $api_instance->deleteComment();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->deleteComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()

try:
    # Delete Comment
    api_response = api_instance.delete_comment()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->deleteComment: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {

    let mut context = CommentV3Api::Context::default();
    let result = client.deleteComment(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


dislikeComment

Dislike Comment

Dislike a comment on a blog post.


/api/v3/comment/dislike

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: text/plain,application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/comment/dislike" \
 -d '{
  "comment" : "comment",
  "blogPost" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

        try {
            'String' result = apiInstance.dislikeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#dislikeComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

        try {
            'String' result = apiInstance.dislikeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#dislikeComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];
CommentLikeV3PostRequest *commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // 

// Dislike Comment
[apiInstance dislikeCommentWith:commentLikeV3PostRequest
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // {CommentLikeV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dislikeComment(commentLikeV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();
            var commentLikeV3PostRequest = new CommentLikeV3PostRequest(); // CommentLikeV3PostRequest | 

            try {
                // Dislike Comment
                'String' result = apiInstance.dislikeComment(commentLikeV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.dislikeComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();
$commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

try {
    $result = $api_instance->dislikeComment($commentLikeV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->dislikeComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();
my $commentLikeV3PostRequest = WWW::OPenAPIClient::Object::CommentLikeV3PostRequest->new(); # CommentLikeV3PostRequest | 

eval {
    my $result = $api_instance->dislikeComment(commentLikeV3PostRequest => $commentLikeV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->dislikeComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()
commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"} # CommentLikeV3PostRequest | 

try:
    # Dislike Comment
    api_response = api_instance.dislike_comment(commentLikeV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->dislikeComment: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {
    let commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest

    let mut context = CommentV3Api::Context::default();
    let result = client.dislikeComment(commentLikeV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
commentLikeV3PostRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


editComment

Edit Comment

TODO


/api/v3/comment/edit

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/comment/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.editComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#editComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.editComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#editComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];

// Edit Comment
[apiInstance editCommentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editComment(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();

            try {
                // Edit Comment
                oas_any_type_not_mapped result = apiInstance.editComment();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.editComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();

try {
    $result = $api_instance->editComment();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->editComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();

eval {
    my $result = $api_instance->editComment();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->editComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()

try:
    # Edit Comment
    api_response = api_instance.edit_comment()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->editComment: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {

    let mut context = CommentV3Api::Context::default();
    let result = client.editComment(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCommentHistory

Get Comment History

TODO


/api/v3/comment/history

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/comment/history"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCommentHistory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#getCommentHistory");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCommentHistory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#getCommentHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];

// Get Comment History
[apiInstance getCommentHistoryWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCommentHistory(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();

            try {
                // Get Comment History
                oas_any_type_not_mapped result = apiInstance.getCommentHistory();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.getCommentHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();

try {
    $result = $api_instance->getCommentHistory();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->getCommentHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();

eval {
    my $result = $api_instance->getCommentHistory();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->getCommentHistory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()

try:
    # Get Comment History
    api_response = api_instance.get_comment_history()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->getCommentHistory: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {

    let mut context = CommentV3Api::Context::default();
    let result = client.getCommentHistory(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCommentReplies

Get Comment Replies

Retrieve more replies from a comment.


/api/v3/comment/replies

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/comment/replies?comment=comment_example&blogPost=blogPost_example&limit=56&rid=rid_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();
        String comment = comment_example; // String | The identifer of the comment from which to retrieve replies.
        String blogPost = blogPost_example; // String | The identifer of the blog post the `comment` belongs to.
        Integer limit = 56; // Integer | How many replies to retrieve.
        String rid = rid_example; // String | The identifer of the last reply in the reply chain.

        try {
            array[CommentModel] result = apiInstance.getCommentReplies(comment, blogPost, limit, rid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#getCommentReplies");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();
        String comment = comment_example; // String | The identifer of the comment from which to retrieve replies.
        String blogPost = blogPost_example; // String | The identifer of the blog post the `comment` belongs to.
        Integer limit = 56; // Integer | How many replies to retrieve.
        String rid = rid_example; // String | The identifer of the last reply in the reply chain.

        try {
            array[CommentModel] result = apiInstance.getCommentReplies(comment, blogPost, limit, rid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#getCommentReplies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];
String *comment = comment_example; // The identifer of the comment from which to retrieve replies. (default to null)
String *blogPost = blogPost_example; // The identifer of the blog post the `comment` belongs to. (default to null)
Integer *limit = 56; // How many replies to retrieve. (default to null)
String *rid = rid_example; // The identifer of the last reply in the reply chain. (default to null)

// Get Comment Replies
[apiInstance getCommentRepliesWith:comment
    blogPost:blogPost
    limit:limit
    rid:rid
              completionHandler: ^(array[CommentModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var comment = comment_example; // {String} The identifer of the comment from which to retrieve replies.
var blogPost = blogPost_example; // {String} The identifer of the blog post the `comment` belongs to.
var limit = 56; // {Integer} How many replies to retrieve.
var rid = rid_example; // {String} The identifer of the last reply in the reply chain.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCommentReplies(comment, blogPost, limit, rid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();
            var comment = comment_example;  // String | The identifer of the comment from which to retrieve replies. (default to null)
            var blogPost = blogPost_example;  // String | The identifer of the blog post the `comment` belongs to. (default to null)
            var limit = 56;  // Integer | How many replies to retrieve. (default to null)
            var rid = rid_example;  // String | The identifer of the last reply in the reply chain. (default to null)

            try {
                // Get Comment Replies
                array[CommentModel] result = apiInstance.getCommentReplies(comment, blogPost, limit, rid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.getCommentReplies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();
$comment = comment_example; // String | The identifer of the comment from which to retrieve replies.
$blogPost = blogPost_example; // String | The identifer of the blog post the `comment` belongs to.
$limit = 56; // Integer | How many replies to retrieve.
$rid = rid_example; // String | The identifer of the last reply in the reply chain.

try {
    $result = $api_instance->getCommentReplies($comment, $blogPost, $limit, $rid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->getCommentReplies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();
my $comment = comment_example; # String | The identifer of the comment from which to retrieve replies.
my $blogPost = blogPost_example; # String | The identifer of the blog post the `comment` belongs to.
my $limit = 56; # Integer | How many replies to retrieve.
my $rid = rid_example; # String | The identifer of the last reply in the reply chain.

eval {
    my $result = $api_instance->getCommentReplies(comment => $comment, blogPost => $blogPost, limit => $limit, rid => $rid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->getCommentReplies: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()
comment = comment_example # String | The identifer of the comment from which to retrieve replies. (default to null)
blogPost = blogPost_example # String | The identifer of the blog post the `comment` belongs to. (default to null)
limit = 56 # Integer | How many replies to retrieve. (default to null)
rid = rid_example # String | The identifer of the last reply in the reply chain. (default to null)

try:
    # Get Comment Replies
    api_response = api_instance.get_comment_replies(comment, blogPost, limit, rid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->getCommentReplies: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {
    let comment = comment_example; // String
    let blogPost = blogPost_example; // String
    let limit = 56; // Integer
    let rid = rid_example; // String

    let mut context = CommentV3Api::Context::default();
    let result = client.getCommentReplies(comment, blogPost, limit, rid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
comment*
String
The identifer of the comment from which to retrieve replies.
Required
blogPost*
String
The identifer of the blog post the `comment` belongs to.
Required
limit*
Integer
How many replies to retrieve.
Required
rid*
String
The identifer of the last reply in the reply chain.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getComments

Get Comments

Get comments for a blog post object. Note that replies to each comment tend to be limited to 3. The extra replies can be retrieved via `getCommentReplies`. The difference in `$response.body#/0/totalReplies` and `$response.body#/0/replies`'s length can determine if more comments need to be loaded.


/api/v3/comment

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/comment?blogPost=blogPost_example&limit=56&fetchAfter=fetchAfter_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();
        String blogPost = blogPost_example; // String | Which blog post to retrieve comments for.
        Integer limit = 56; // Integer | The maximum number of comments to return. This should be set to 20 by default.
        String fetchAfter = fetchAfter_example; // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

        try {
            array[CommentModel] result = apiInstance.getComments(blogPost, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#getComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();
        String blogPost = blogPost_example; // String | Which blog post to retrieve comments for.
        Integer limit = 56; // Integer | The maximum number of comments to return. This should be set to 20 by default.
        String fetchAfter = fetchAfter_example; // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

        try {
            array[CommentModel] result = apiInstance.getComments(blogPost, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#getComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];
String *blogPost = blogPost_example; // Which blog post to retrieve comments for. (default to null)
Integer *limit = 56; // The maximum number of comments to return. This should be set to 20 by default. (default to null)
String *fetchAfter = fetchAfter_example; // When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`. (optional) (default to null)

// Get Comments
[apiInstance getCommentsWith:blogPost
    limit:limit
    fetchAfter:fetchAfter
              completionHandler: ^(array[CommentModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var blogPost = blogPost_example; // {String} Which blog post to retrieve comments for.
var limit = 56; // {Integer} The maximum number of comments to return. This should be set to 20 by default.
var opts = {
  'fetchAfter': fetchAfter_example // {String} When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getComments(blogPost, limit, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();
            var blogPost = blogPost_example;  // String | Which blog post to retrieve comments for. (default to null)
            var limit = 56;  // Integer | The maximum number of comments to return. This should be set to 20 by default. (default to null)
            var fetchAfter = fetchAfter_example;  // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`. (optional)  (default to null)

            try {
                // Get Comments
                array[CommentModel] result = apiInstance.getComments(blogPost, limit, fetchAfter);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.getComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();
$blogPost = blogPost_example; // String | Which blog post to retrieve comments for.
$limit = 56; // Integer | The maximum number of comments to return. This should be set to 20 by default.
$fetchAfter = fetchAfter_example; // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

try {
    $result = $api_instance->getComments($blogPost, $limit, $fetchAfter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->getComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();
my $blogPost = blogPost_example; # String | Which blog post to retrieve comments for.
my $limit = 56; # Integer | The maximum number of comments to return. This should be set to 20 by default.
my $fetchAfter = fetchAfter_example; # String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

eval {
    my $result = $api_instance->getComments(blogPost => $blogPost, limit => $limit, fetchAfter => $fetchAfter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->getComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()
blogPost = blogPost_example # String | Which blog post to retrieve comments for. (default to null)
limit = 56 # Integer | The maximum number of comments to return. This should be set to 20 by default. (default to null)
fetchAfter = fetchAfter_example # String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`. (optional) (default to null)

try:
    # Get Comments
    api_response = api_instance.get_comments(blogPost, limit, fetchAfter=fetchAfter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->getComments: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {
    let blogPost = blogPost_example; // String
    let limit = 56; // Integer
    let fetchAfter = fetchAfter_example; // String

    let mut context = CommentV3Api::Context::default();
    let result = client.getComments(blogPost, limit, fetchAfter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
blogPost*
String
Which blog post to retrieve comments for.
Required
limit*
Integer
The maximum number of comments to return. This should be set to 20 by default.
Required
fetchAfter
String
When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


likeComment

Like Comment

Like a comment on a blog post.


/api/v3/comment/like

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: text/plain,application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/comment/like" \
 -d '{
  "comment" : "comment",
  "blogPost" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

        try {
            'String' result = apiInstance.likeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#likeComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

        try {
            'String' result = apiInstance.likeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#likeComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];
CommentLikeV3PostRequest *commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // 

// Like Comment
[apiInstance likeCommentWith:commentLikeV3PostRequest
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // {CommentLikeV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.likeComment(commentLikeV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();
            var commentLikeV3PostRequest = new CommentLikeV3PostRequest(); // CommentLikeV3PostRequest | 

            try {
                // Like Comment
                'String' result = apiInstance.likeComment(commentLikeV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.likeComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();
$commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

try {
    $result = $api_instance->likeComment($commentLikeV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->likeComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();
my $commentLikeV3PostRequest = WWW::OPenAPIClient::Object::CommentLikeV3PostRequest->new(); # CommentLikeV3PostRequest | 

eval {
    my $result = $api_instance->likeComment(commentLikeV3PostRequest => $commentLikeV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->likeComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()
commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"} # CommentLikeV3PostRequest | 

try:
    # Like Comment
    api_response = api_instance.like_comment(commentLikeV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->likeComment: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {
    let commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest

    let mut context = CommentV3Api::Context::default();
    let result = client.likeComment(commentLikeV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
commentLikeV3PostRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


pinComment

Pin Comment

TODO


/api/v3/comment/pin

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/comment/pin"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.pinComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#pinComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.pinComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#pinComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];

// Pin Comment
[apiInstance pinCommentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pinComment(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();

            try {
                // Pin Comment
                oas_any_type_not_mapped result = apiInstance.pinComment();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.pinComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();

try {
    $result = $api_instance->pinComment();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->pinComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();

eval {
    my $result = $api_instance->pinComment();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->pinComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()

try:
    # Pin Comment
    api_response = api_instance.pin_comment()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->pinComment: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {

    let mut context = CommentV3Api::Context::default();
    let result = client.pinComment(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


postComment

Post Comment

Post a new comment to a blog post object.


/api/v3/comment

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/comment" \
 -d '{
  "text" : "text",
  "blogPost" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();
        CommentV3PostRequest commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest | 

        try {
            CommentV3PostResponse result = apiInstance.postComment(commentV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#postComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();
        CommentV3PostRequest commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest | 

        try {
            CommentV3PostResponse result = apiInstance.postComment(commentV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#postComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];
CommentV3PostRequest *commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // 

// Post Comment
[apiInstance postCommentWith:commentV3PostRequest
              completionHandler: ^(CommentV3PostResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // {CommentV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postComment(commentV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();
            var commentV3PostRequest = new CommentV3PostRequest(); // CommentV3PostRequest | 

            try {
                // Post Comment
                CommentV3PostResponse result = apiInstance.postComment(commentV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.postComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();
$commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest | 

try {
    $result = $api_instance->postComment($commentV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->postComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();
my $commentV3PostRequest = WWW::OPenAPIClient::Object::CommentV3PostRequest->new(); # CommentV3PostRequest | 

eval {
    my $result = $api_instance->postComment(commentV3PostRequest => $commentV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->postComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()
commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"} # CommentV3PostRequest | 

try:
    # Post Comment
    api_response = api_instance.post_comment(commentV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->postComment: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {
    let commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest

    let mut context = CommentV3Api::Context::default();
    let result = client.postComment(commentV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
commentV3PostRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ConnectedAccountsV2

callback

Callback

TODO


/api/v2/connect/{site}/callback

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/connect/{site}/callback"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsV2Api;

import java.io.File;
import java.util.*;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();
        String site = site_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.callback(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#callback");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsV2Api;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();
        String site = site_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.callback(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#callback");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ConnectedAccountsV2Api *apiInstance = [[ConnectedAccountsV2Api alloc] init];
String *site = site_example; //  (default to null)

// Callback
[apiInstance callbackWith:site
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ConnectedAccountsV2Api()
var site = site_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.callback(site, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsV2Api();
            var site = site_example;  // String |  (default to null)

            try {
                // Callback
                oas_any_type_not_mapped result = apiInstance.callback(site);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsV2Api.callback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsV2Api();
$site = site_example; // String | 

try {
    $result = $api_instance->callback($site);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsV2Api->callback: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsV2Api->new();
my $site = site_example; # String | 

eval {
    my $result = $api_instance->callback(site => $site);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsV2Api->callback: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsV2Api()
site = site_example # String |  (default to null)

try:
    # Callback
    api_response = api_instance.callback(site)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsV2Api->callback: %s\n" % e)
extern crate ConnectedAccountsV2Api;

pub fn main() {
    let site = site_example; // String

    let mut context = ConnectedAccountsV2Api::Context::default();
    let result = client.callback(site, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
site*
String
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


complete

Complete

TODO


/api/v2/connect/complete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/connect/complete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsV2Api;

import java.io.File;
import java.util.*;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.complete();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#complete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsV2Api;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.complete();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#complete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ConnectedAccountsV2Api *apiInstance = [[ConnectedAccountsV2Api alloc] init];

// Complete
[apiInstance completeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ConnectedAccountsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.complete(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsV2Api();

            try {
                // Complete
                oas_any_type_not_mapped result = apiInstance.complete();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsV2Api.complete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsV2Api();

try {
    $result = $api_instance->complete();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsV2Api->complete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsV2Api->new();

eval {
    my $result = $api_instance->complete();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsV2Api->complete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsV2Api()

try:
    # Complete
    api_response = api_instance.complete()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsV2Api->complete: %s\n" % e)
extern crate ConnectedAccountsV2Api;

pub fn main() {

    let mut context = ConnectedAccountsV2Api::Context::default();
    let result = client.complete(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


dissociate

Dissociate

TODO


/api/v2/connect/dissociate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/connect/dissociate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsV2Api;

import java.io.File;
import java.util.*;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.dissociate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#dissociate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsV2Api;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.dissociate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#dissociate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ConnectedAccountsV2Api *apiInstance = [[ConnectedAccountsV2Api alloc] init];

// Dissociate
[apiInstance dissociateWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ConnectedAccountsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dissociate(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsV2Api();

            try {
                // Dissociate
                oas_any_type_not_mapped result = apiInstance.dissociate();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsV2Api.dissociate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsV2Api();

try {
    $result = $api_instance->dissociate();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsV2Api->dissociate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsV2Api->new();

eval {
    my $result = $api_instance->dissociate();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsV2Api->dissociate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsV2Api()

try:
    # Dissociate
    api_response = api_instance.dissociate()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsV2Api->dissociate: %s\n" % e)
extern crate ConnectedAccountsV2Api;

pub fn main() {

    let mut context = ConnectedAccountsV2Api::Context::default();
    let result = client.dissociate(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getAccountConnect

Connect

TODO


/api/v2/connect/{site}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/connect/{site}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsV2Api;

import java.io.File;
import java.util.*;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();
        String site = site_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.getAccountConnect(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#getAccountConnect");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsV2Api;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();
        String site = site_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.getAccountConnect(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#getAccountConnect");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ConnectedAccountsV2Api *apiInstance = [[ConnectedAccountsV2Api alloc] init];
String *site = site_example; //  (default to null)

// Connect
[apiInstance getAccountConnectWith:site
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ConnectedAccountsV2Api()
var site = site_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountConnect(site, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsV2Api();
            var site = site_example;  // String |  (default to null)

            try {
                // Connect
                oas_any_type_not_mapped result = apiInstance.getAccountConnect(site);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsV2Api.getAccountConnect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsV2Api();
$site = site_example; // String | 

try {
    $result = $api_instance->getAccountConnect($site);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsV2Api->getAccountConnect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsV2Api->new();
my $site = site_example; # String | 

eval {
    my $result = $api_instance->getAccountConnect(site => $site);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsV2Api->getAccountConnect: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsV2Api()
site = site_example # String |  (default to null)

try:
    # Connect
    api_response = api_instance.get_account_connect(site)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsV2Api->getAccountConnect: %s\n" % e)
extern crate ConnectedAccountsV2Api;

pub fn main() {
    let site = site_example; // String

    let mut context = ConnectedAccountsV2Api::Context::default();
    let result = client.getAccountConnect(site, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
site*
String
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listConnections

List Connections

List the available 3rd party accounts for the user's profile.


/api/v2/connect/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/connect/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsV2Api;

import java.io.File;
import java.util.*;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();

        try {
            array[ConnectedAccountModel] result = apiInstance.listConnections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#listConnections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsV2Api;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();

        try {
            array[ConnectedAccountModel] result = apiInstance.listConnections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#listConnections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ConnectedAccountsV2Api *apiInstance = [[ConnectedAccountsV2Api alloc] init];

// List Connections
[apiInstance listConnectionsWithCompletionHandler: 
              ^(array[ConnectedAccountModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ConnectedAccountsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listConnections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsV2Api();

            try {
                // List Connections
                array[ConnectedAccountModel] result = apiInstance.listConnections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsV2Api.listConnections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsV2Api();

try {
    $result = $api_instance->listConnections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsV2Api->listConnections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsV2Api->new();

eval {
    my $result = $api_instance->listConnections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsV2Api->listConnections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsV2Api()

try:
    # List Connections
    api_response = api_instance.list_connections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsV2Api->listConnections: %s\n" % e)
extern crate ConnectedAccountsV2Api;

pub fn main() {

    let mut context = ConnectedAccountsV2Api::Context::default();
    let result = client.listConnections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


refresh

Refresh

TODO


/api/v2/connect/refresh

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/connect/refresh"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsV2Api;

import java.io.File;
import java.util.*;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.refresh();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#refresh");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsV2Api;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.refresh();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#refresh");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ConnectedAccountsV2Api *apiInstance = [[ConnectedAccountsV2Api alloc] init];

// Refresh
[apiInstance refreshWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ConnectedAccountsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refresh(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsV2Api();

            try {
                // Refresh
                oas_any_type_not_mapped result = apiInstance.refresh();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsV2Api.refresh: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsV2Api();

try {
    $result = $api_instance->refresh();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsV2Api->refresh: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsV2Api->new();

eval {
    my $result = $api_instance->refresh();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsV2Api->refresh: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsV2Api()

try:
    # Refresh
    api_response = api_instance.refresh()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsV2Api->refresh: %s\n" % e)
extern crate ConnectedAccountsV2Api;

pub fn main() {

    let mut context = ConnectedAccountsV2Api::Context::default();
    let result = client.refresh(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ContentUploadV3

abortMultipartUploadV3

Abort Multipart Upload

TODO


/api/v3/content/upload/s3/multipart/abort

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/upload/s3/multipart/abort"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadV3Api;

import java.io.File;
import java.util.*;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#abortMultipartUploadV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadV3Api;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#abortMultipartUploadV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentUploadV3Api *apiInstance = [[ContentUploadV3Api alloc] init];

// Abort Multipart Upload
[apiInstance abortMultipartUploadV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentUploadV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.abortMultipartUploadV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentUploadV3Api();

            try {
                // Abort Multipart Upload
                oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadV3Api.abortMultipartUploadV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadV3Api();

try {
    $result = $api_instance->abortMultipartUploadV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadV3Api->abortMultipartUploadV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadV3Api->new();

eval {
    my $result = $api_instance->abortMultipartUploadV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadV3Api->abortMultipartUploadV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadV3Api()

try:
    # Abort Multipart Upload
    api_response = api_instance.abort_multipart_upload_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadV3Api->abortMultipartUploadV3: %s\n" % e)
extern crate ContentUploadV3Api;

pub fn main() {

    let mut context = ContentUploadV3Api::Context::default();
    let result = client.abortMultipartUploadV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


completeMultipartUploadContent

Complete Multipart Upload

TODO


/api/v3/content/upload/s3/multipart/complete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/upload/s3/multipart/complete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadV3Api;

import java.io.File;
import java.util.*;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.completeMultipartUploadContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#completeMultipartUploadContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadV3Api;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.completeMultipartUploadContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#completeMultipartUploadContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentUploadV3Api *apiInstance = [[ContentUploadV3Api alloc] init];

// Complete Multipart Upload
[apiInstance completeMultipartUploadContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentUploadV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.completeMultipartUploadContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentUploadV3Api();

            try {
                // Complete Multipart Upload
                oas_any_type_not_mapped result = apiInstance.completeMultipartUploadContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadV3Api.completeMultipartUploadContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadV3Api();

try {
    $result = $api_instance->completeMultipartUploadContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadV3Api->completeMultipartUploadContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadV3Api->new();

eval {
    my $result = $api_instance->completeMultipartUploadContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadV3Api->completeMultipartUploadContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadV3Api()

try:
    # Complete Multipart Upload
    api_response = api_instance.complete_multipart_upload_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadV3Api->completeMultipartUploadContent: %s\n" % e)
extern crate ContentUploadV3Api;

pub fn main() {

    let mut context = ContentUploadV3Api::Context::default();
    let result = client.completeMultipartUploadContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


createMultipartUploadV3

Create Multipart Upload

TODO


/api/v3/content/upload/s3/multipart

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/upload/s3/multipart"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadV3Api;

import java.io.File;
import java.util.*;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createMultipartUploadV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#createMultipartUploadV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadV3Api;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createMultipartUploadV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#createMultipartUploadV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentUploadV3Api *apiInstance = [[ContentUploadV3Api alloc] init];

// Create Multipart Upload
[apiInstance createMultipartUploadV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentUploadV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMultipartUploadV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentUploadV3Api();

            try {
                // Create Multipart Upload
                oas_any_type_not_mapped result = apiInstance.createMultipartUploadV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadV3Api.createMultipartUploadV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadV3Api();

try {
    $result = $api_instance->createMultipartUploadV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadV3Api->createMultipartUploadV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadV3Api->new();

eval {
    my $result = $api_instance->createMultipartUploadV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadV3Api->createMultipartUploadV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadV3Api()

try:
    # Create Multipart Upload
    api_response = api_instance.create_multipart_upload_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadV3Api->createMultipartUploadV3: %s\n" % e)
extern crate ContentUploadV3Api;

pub fn main() {

    let mut context = ContentUploadV3Api::Context::default();
    let result = client.createMultipartUploadV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUploadedPartsV3

Get Uploaded Parts

TODO


/api/v3/content/upload/s3/multipart

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/upload/s3/multipart"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadV3Api;

import java.io.File;
import java.util.*;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUploadedPartsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#getUploadedPartsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadV3Api;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUploadedPartsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#getUploadedPartsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentUploadV3Api *apiInstance = [[ContentUploadV3Api alloc] init];

// Get Uploaded Parts
[apiInstance getUploadedPartsV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentUploadV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUploadedPartsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentUploadV3Api();

            try {
                // Get Uploaded Parts
                oas_any_type_not_mapped result = apiInstance.getUploadedPartsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadV3Api.getUploadedPartsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadV3Api();

try {
    $result = $api_instance->getUploadedPartsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadV3Api->getUploadedPartsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadV3Api->new();

eval {
    my $result = $api_instance->getUploadedPartsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadV3Api->getUploadedPartsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadV3Api()

try:
    # Get Uploaded Parts
    api_response = api_instance.get_uploaded_parts_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadV3Api->getUploadedPartsV3: %s\n" % e)
extern crate ContentUploadV3Api;

pub fn main() {

    let mut context = ContentUploadV3Api::Context::default();
    let result = client.getUploadedPartsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


signPartUploadContent

Sign Part Upload

TODO


/api/v3/content/upload/s3/multipart/sign

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/upload/s3/multipart/sign"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadV3Api;

import java.io.File;
import java.util.*;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.signPartUploadContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#signPartUploadContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadV3Api;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.signPartUploadContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#signPartUploadContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentUploadV3Api *apiInstance = [[ContentUploadV3Api alloc] init];

// Sign Part Upload
[apiInstance signPartUploadContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentUploadV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.signPartUploadContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentUploadV3Api();

            try {
                // Sign Part Upload
                oas_any_type_not_mapped result = apiInstance.signPartUploadContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadV3Api.signPartUploadContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadV3Api();

try {
    $result = $api_instance->signPartUploadContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadV3Api->signPartUploadContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadV3Api->new();

eval {
    my $result = $api_instance->signPartUploadContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadV3Api->signPartUploadContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadV3Api()

try:
    # Sign Part Upload
    api_response = api_instance.sign_part_upload_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadV3Api->signPartUploadContent: %s\n" % e)
extern crate ContentUploadV3Api;

pub fn main() {

    let mut context = ContentUploadV3Api::Context::default();
    let result = client.signPartUploadContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


thumbnailUpdateSubscribe

Thumbnail Update Subscribe

TODO - Not used in Floatplane code.


/api/v3/content/thumbnail/subscribe

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/thumbnail/subscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadV3Api;

import java.io.File;
import java.util.*;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.thumbnailUpdateSubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#thumbnailUpdateSubscribe");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadV3Api;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.thumbnailUpdateSubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#thumbnailUpdateSubscribe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentUploadV3Api *apiInstance = [[ContentUploadV3Api alloc] init];

// Thumbnail Update Subscribe
[apiInstance thumbnailUpdateSubscribeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentUploadV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.thumbnailUpdateSubscribe(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentUploadV3Api();

            try {
                // Thumbnail Update Subscribe
                oas_any_type_not_mapped result = apiInstance.thumbnailUpdateSubscribe();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadV3Api.thumbnailUpdateSubscribe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadV3Api();

try {
    $result = $api_instance->thumbnailUpdateSubscribe();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadV3Api->thumbnailUpdateSubscribe: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadV3Api->new();

eval {
    my $result = $api_instance->thumbnailUpdateSubscribe();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadV3Api->thumbnailUpdateSubscribe: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadV3Api()

try:
    # Thumbnail Update Subscribe
    api_response = api_instance.thumbnail_update_subscribe()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadV3Api->thumbnailUpdateSubscribe: %s\n" % e)
extern crate ContentUploadV3Api;

pub fn main() {

    let mut context = ContentUploadV3Api::Context::default();
    let result = client.thumbnailUpdateSubscribe(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


uploadThumbnailV3

Upload Thumbnail

TODO - Not used in Floatplane code.


/api/v3/content/upload/thumbnail

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/upload/thumbnail"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadV3Api;

import java.io.File;
import java.util.*;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadThumbnailV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#uploadThumbnailV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadV3Api;

public class ContentUploadV3ApiExample {
    public static void main(String[] args) {
        ContentUploadV3Api apiInstance = new ContentUploadV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadThumbnailV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadV3Api#uploadThumbnailV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentUploadV3Api *apiInstance = [[ContentUploadV3Api alloc] init];

// Upload Thumbnail
[apiInstance uploadThumbnailV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentUploadV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadThumbnailV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentUploadV3Api();

            try {
                // Upload Thumbnail
                oas_any_type_not_mapped result = apiInstance.uploadThumbnailV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadV3Api.uploadThumbnailV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadV3Api();

try {
    $result = $api_instance->uploadThumbnailV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadV3Api->uploadThumbnailV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadV3Api->new();

eval {
    my $result = $api_instance->uploadThumbnailV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadV3Api->uploadThumbnailV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadV3Api()

try:
    # Upload Thumbnail
    api_response = api_instance.upload_thumbnail_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadV3Api->uploadThumbnailV3: %s\n" % e)
extern crate ContentUploadV3Api;

pub fn main() {

    let mut context = ContentUploadV3Api::Context::default();
    let result = client.uploadThumbnailV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ContentV3

dislikeContent

Dislike Content

Toggles the dislike status on a piece of content. If liked before, it will turn into a dislike. If disliked before, the dislike will be removed.


/api/v3/content/dislike

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/content/dislike" \
 -d '{
  "id" : "id",
  "contentType" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        ContentLikeV3Request contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

        try {
            array['String'] result = apiInstance.dislikeContent(contentLikeV3Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#dislikeContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        ContentLikeV3Request contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

        try {
            array['String'] result = apiInstance.dislikeContent(contentLikeV3Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#dislikeContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
ContentLikeV3Request *contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // 

// Dislike Content
[apiInstance dislikeContentWith:contentLikeV3Request
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // {ContentLikeV3Request} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dislikeContent(contentLikeV3Request, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var contentLikeV3Request = new ContentLikeV3Request(); // ContentLikeV3Request | 

            try {
                // Dislike Content
                array['String'] result = apiInstance.dislikeContent(contentLikeV3Request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.dislikeContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

try {
    $result = $api_instance->dislikeContent($contentLikeV3Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->dislikeContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $contentLikeV3Request = WWW::OPenAPIClient::Object::ContentLikeV3Request->new(); # ContentLikeV3Request | 

eval {
    my $result = $api_instance->dislikeContent(contentLikeV3Request => $contentLikeV3Request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->dislikeContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"} # ContentLikeV3Request | 

try:
    # Dislike Content
    api_response = api_instance.dislike_content(contentLikeV3Request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->dislikeContent: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request

    let mut context = ContentV3Api::Context::default();
    let result = client.dislikeContent(contentLikeV3Request, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
contentLikeV3Request *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getAudioContent

Get Audio Content

TODO


/api/v3/content/audio

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/audio"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAudioContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getAudioContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAudioContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getAudioContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];

// Get Audio Content
[apiInstance getAudioContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAudioContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();

            try {
                // Get Audio Content
                oas_any_type_not_mapped result = apiInstance.getAudioContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getAudioContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();

try {
    $result = $api_instance->getAudioContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getAudioContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();

eval {
    my $result = $api_instance->getAudioContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getAudioContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()

try:
    # Get Audio Content
    api_response = api_instance.get_audio_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getAudioContent: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {

    let mut context = ContentV3Api::Context::default();
    let result = client.getAudioContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getBlogPost

Get Blog Post

Retrieve more details on a specific blog post object for viewing.


/api/v3/content/post

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/post?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the post to be retrieved.

        try {
            ContentPostV3Response result = apiInstance.getBlogPost(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getBlogPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the post to be retrieved.

        try {
            ContentPostV3Response result = apiInstance.getBlogPost(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getBlogPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
String *id = id_example; // The ID of the post to be retrieved. (default to null)

// Get Blog Post
[apiInstance getBlogPostWith:id
              completionHandler: ^(ContentPostV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var id = id_example; // {String} The ID of the post to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBlogPost(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var id = id_example;  // String | The ID of the post to be retrieved. (default to null)

            try {
                // Get Blog Post
                ContentPostV3Response result = apiInstance.getBlogPost(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getBlogPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$id = id_example; // String | The ID of the post to be retrieved.

try {
    $result = $api_instance->getBlogPost($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getBlogPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $id = id_example; # String | The ID of the post to be retrieved.

eval {
    my $result = $api_instance->getBlogPost(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getBlogPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
id = id_example # String | The ID of the post to be retrieved. (default to null)

try:
    # Get Blog Post
    api_response = api_instance.get_blog_post(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getBlogPost: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = ContentV3Api::Context::default();
    let result = client.getBlogPost(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The ID of the post to be retrieved.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getContent

Get Content

TODO - Not used in Floatplane code.


/api/v3/content/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];

// Get Content
[apiInstance getContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();

            try {
                // Get Content
                oas_any_type_not_mapped result = apiInstance.getContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();

try {
    $result = $api_instance->getContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();

eval {
    my $result = $api_instance->getContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()

try:
    # Get Content
    api_response = api_instance.get_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getContent: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {

    let mut context = ContentV3Api::Context::default();
    let result = client.getContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getContentTags

Get Content Tags

Retrieve all tags and the number of times the tags have been used for the specified creator(s).


/api/v3/content/tags

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/tags?creatorIds="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        array[String] creatorIds = ; // array[String] | The creator(s) to search by.

        try {
            map['String', 'Integer'] result = apiInstance.getContentTags(creatorIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getContentTags");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        array[String] creatorIds = ; // array[String] | The creator(s) to search by.

        try {
            map['String', 'Integer'] result = apiInstance.getContentTags(creatorIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getContentTags");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
array[String] *creatorIds = ; // The creator(s) to search by. (default to null)

// Get Content Tags
[apiInstance getContentTagsWith:creatorIds
              completionHandler: ^(map['String', 'Integer'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var creatorIds = ; // {array[String]} The creator(s) to search by.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContentTags(creatorIds, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var creatorIds = new array[String](); // array[String] | The creator(s) to search by. (default to null)

            try {
                // Get Content Tags
                map['String', 'Integer'] result = apiInstance.getContentTags(creatorIds);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getContentTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$creatorIds = ; // array[String] | The creator(s) to search by.

try {
    $result = $api_instance->getContentTags($creatorIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getContentTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $creatorIds = []; # array[String] | The creator(s) to search by.

eval {
    my $result = $api_instance->getContentTags(creatorIds => $creatorIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getContentTags: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
creatorIds =  # array[String] | The creator(s) to search by. (default to null)

try:
    # Get Content Tags
    api_response = api_instance.get_content_tags(creatorIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getContentTags: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let creatorIds = ; // array[String]

    let mut context = ContentV3Api::Context::default();
    let result = client.getContentTags(creatorIds, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorIds*
array[String]
The creator(s) to search by.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorBlogPosts

Get Creator Blog Posts

Retrieve a paginated list of blog posts from a creator. Or search for blog posts from a creator. Example query: https://www.floatplane.com/api/v3/content/creator?id=59f94c0bdd241b70349eb72b&fromDate=2021-07-24T07:00:00.001Z&toDate=2022-07-27T06:59:59.099Z&hasVideo=true&hasAudio=true&hasPicture=false&hasText=false&fromDuration=1020&toDuration=9900&sort=DESC&search=thor&tags[0]=tjm


/api/v3/content/creator

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/creator?id=id_example&channel=channel_example&limit=56&fetchAfter=56&search=search_example&tags=&hasVideo=true&hasAudio=true&hasPicture=true&hasText=true&sort=sort_example&fromDuration=56&toDuration=56&fromDate=2022-07-24T07:00:00.001Z&toDate=2022-07-24T07:00:00.001Z"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The GUID of the creator to retrieve posts from.
        String channel = channel_example; // String | The id of a creator's specific channel from which to retrieve posts.
        Integer limit = 56; // Integer | The maximum number of posts to return.
        Integer fetchAfter = 56; // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
        String search = search_example; // String | Search filter to look for specific posts.
        array[String] tags = ; // array[String] | An array of tags to search against, possibly in addition to `search`.
        Boolean hasVideo = true; // Boolean | If true, include blog posts with video attachments.
        Boolean hasAudio = true; // Boolean | If true, include blog posts with audio attachments.
        Boolean hasPicture = true; // Boolean | If true, include blog posts with picture attachments.
        Boolean hasText = true; // Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
        String sort = sort_example; // String | `DESC` = Newest First. `ASC` = Oldest First.
        Integer fromDuration = 56; // Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
        Integer toDuration = 56; // Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
        Date fromDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or after this filter date.
        Date toDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or before this filter date.

        try {
            array[BlogPostModelV3] result = apiInstance.getCreatorBlogPosts(id, channel, limit, fetchAfter, search, tags, hasVideo, hasAudio, hasPicture, hasText, sort, fromDuration, toDuration, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The GUID of the creator to retrieve posts from.
        String channel = channel_example; // String | The id of a creator's specific channel from which to retrieve posts.
        Integer limit = 56; // Integer | The maximum number of posts to return.
        Integer fetchAfter = 56; // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
        String search = search_example; // String | Search filter to look for specific posts.
        array[String] tags = ; // array[String] | An array of tags to search against, possibly in addition to `search`.
        Boolean hasVideo = true; // Boolean | If true, include blog posts with video attachments.
        Boolean hasAudio = true; // Boolean | If true, include blog posts with audio attachments.
        Boolean hasPicture = true; // Boolean | If true, include blog posts with picture attachments.
        Boolean hasText = true; // Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
        String sort = sort_example; // String | `DESC` = Newest First. `ASC` = Oldest First.
        Integer fromDuration = 56; // Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
        Integer toDuration = 56; // Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
        Date fromDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or after this filter date.
        Date toDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or before this filter date.

        try {
            array[BlogPostModelV3] result = apiInstance.getCreatorBlogPosts(id, channel, limit, fetchAfter, search, tags, hasVideo, hasAudio, hasPicture, hasText, sort, fromDuration, toDuration, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
String *id = id_example; // The GUID of the creator to retrieve posts from. (default to null)
String *channel = channel_example; // The id of a creator's specific channel from which to retrieve posts. (optional) (default to null)
Integer *limit = 56; // The maximum number of posts to return. (optional) (default to null)
Integer *fetchAfter = 56; // The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results. (optional) (default to null)
String *search = search_example; // Search filter to look for specific posts. (optional) (default to null)
array[String] *tags = ; // An array of tags to search against, possibly in addition to `search`. (optional) (default to null)
Boolean *hasVideo = true; // If true, include blog posts with video attachments. (optional) (default to null)
Boolean *hasAudio = true; // If true, include blog posts with audio attachments. (optional) (default to null)
Boolean *hasPicture = true; // If true, include blog posts with picture attachments. (optional) (default to null)
Boolean *hasText = true; // If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results. (optional) (default to null)
String *sort = sort_example; // `DESC` = Newest First. `ASC` = Oldest First. (optional) (default to null)
Integer *fromDuration = 56; // Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional) (default to null)
Integer *toDuration = 56; // Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional) (default to null)
Date *fromDate = 2022-07-24T07:00:00.001Z; // Include posts where the publication date is on or after this filter date. (optional) (default to null)
Date *toDate = 2022-07-24T07:00:00.001Z; // Include posts where the publication date is on or before this filter date. (optional) (default to null)

// Get Creator Blog Posts
[apiInstance getCreatorBlogPostsWith:id
    channel:channel
    limit:limit
    fetchAfter:fetchAfter
    search:search
    tags:tags
    hasVideo:hasVideo
    hasAudio:hasAudio
    hasPicture:hasPicture
    hasText:hasText
    sort:sort
    fromDuration:fromDuration
    toDuration:toDuration
    fromDate:fromDate
    toDate:toDate
              completionHandler: ^(array[BlogPostModelV3] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var id = id_example; // {String} The GUID of the creator to retrieve posts from.
var opts = {
  'channel': channel_example, // {String} The id of a creator's specific channel from which to retrieve posts.
  'limit': 56, // {Integer} The maximum number of posts to return.
  'fetchAfter': 56, // {Integer} The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
  'search': search_example, // {String} Search filter to look for specific posts.
  'tags': , // {array[String]} An array of tags to search against, possibly in addition to `search`.
  'hasVideo': true, // {Boolean} If true, include blog posts with video attachments.
  'hasAudio': true, // {Boolean} If true, include blog posts with audio attachments.
  'hasPicture': true, // {Boolean} If true, include blog posts with picture attachments.
  'hasText': true, // {Boolean} If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
  'sort': sort_example, // {String} `DESC` = Newest First. `ASC` = Oldest First.
  'fromDuration': 56, // {Integer} Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
  'toDuration': 56, // {Integer} Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
  'fromDate': 2022-07-24T07:00:00.001Z, // {Date} Include posts where the publication date is on or after this filter date.
  'toDate': 2022-07-24T07:00:00.001Z // {Date} Include posts where the publication date is on or before this filter date.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorBlogPosts(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var id = id_example;  // String | The GUID of the creator to retrieve posts from. (default to null)
            var channel = channel_example;  // String | The id of a creator's specific channel from which to retrieve posts. (optional)  (default to null)
            var limit = 56;  // Integer | The maximum number of posts to return. (optional)  (default to null)
            var fetchAfter = 56;  // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results. (optional)  (default to null)
            var search = search_example;  // String | Search filter to look for specific posts. (optional)  (default to null)
            var tags = new array[String](); // array[String] | An array of tags to search against, possibly in addition to `search`. (optional)  (default to null)
            var hasVideo = true;  // Boolean | If true, include blog posts with video attachments. (optional)  (default to null)
            var hasAudio = true;  // Boolean | If true, include blog posts with audio attachments. (optional)  (default to null)
            var hasPicture = true;  // Boolean | If true, include blog posts with picture attachments. (optional)  (default to null)
            var hasText = true;  // Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results. (optional)  (default to null)
            var sort = sort_example;  // String | `DESC` = Newest First. `ASC` = Oldest First. (optional)  (default to null)
            var fromDuration = 56;  // Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional)  (default to null)
            var toDuration = 56;  // Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional)  (default to null)
            var fromDate = 2022-07-24T07:00:00.001Z;  // Date | Include posts where the publication date is on or after this filter date. (optional)  (default to null)
            var toDate = 2022-07-24T07:00:00.001Z;  // Date | Include posts where the publication date is on or before this filter date. (optional)  (default to null)

            try {
                // Get Creator Blog Posts
                array[BlogPostModelV3] result = apiInstance.getCreatorBlogPosts(id, channel, limit, fetchAfter, search, tags, hasVideo, hasAudio, hasPicture, hasText, sort, fromDuration, toDuration, fromDate, toDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getCreatorBlogPosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$id = id_example; // String | The GUID of the creator to retrieve posts from.
$channel = channel_example; // String | The id of a creator's specific channel from which to retrieve posts.
$limit = 56; // Integer | The maximum number of posts to return.
$fetchAfter = 56; // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
$search = search_example; // String | Search filter to look for specific posts.
$tags = ; // array[String] | An array of tags to search against, possibly in addition to `search`.
$hasVideo = true; // Boolean | If true, include blog posts with video attachments.
$hasAudio = true; // Boolean | If true, include blog posts with audio attachments.
$hasPicture = true; // Boolean | If true, include blog posts with picture attachments.
$hasText = true; // Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
$sort = sort_example; // String | `DESC` = Newest First. `ASC` = Oldest First.
$fromDuration = 56; // Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
$toDuration = 56; // Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
$fromDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or after this filter date.
$toDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or before this filter date.

try {
    $result = $api_instance->getCreatorBlogPosts($id, $channel, $limit, $fetchAfter, $search, $tags, $hasVideo, $hasAudio, $hasPicture, $hasText, $sort, $fromDuration, $toDuration, $fromDate, $toDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getCreatorBlogPosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $id = id_example; # String | The GUID of the creator to retrieve posts from.
my $channel = channel_example; # String | The id of a creator's specific channel from which to retrieve posts.
my $limit = 56; # Integer | The maximum number of posts to return.
my $fetchAfter = 56; # Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
my $search = search_example; # String | Search filter to look for specific posts.
my $tags = []; # array[String] | An array of tags to search against, possibly in addition to `search`.
my $hasVideo = true; # Boolean | If true, include blog posts with video attachments.
my $hasAudio = true; # Boolean | If true, include blog posts with audio attachments.
my $hasPicture = true; # Boolean | If true, include blog posts with picture attachments.
my $hasText = true; # Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
my $sort = sort_example; # String | `DESC` = Newest First. `ASC` = Oldest First.
my $fromDuration = 56; # Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
my $toDuration = 56; # Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
my $fromDate = 2022-07-24T07:00:00.001Z; # Date | Include posts where the publication date is on or after this filter date.
my $toDate = 2022-07-24T07:00:00.001Z; # Date | Include posts where the publication date is on or before this filter date.

eval {
    my $result = $api_instance->getCreatorBlogPosts(id => $id, channel => $channel, limit => $limit, fetchAfter => $fetchAfter, search => $search, tags => $tags, hasVideo => $hasVideo, hasAudio => $hasAudio, hasPicture => $hasPicture, hasText => $hasText, sort => $sort, fromDuration => $fromDuration, toDuration => $toDuration, fromDate => $fromDate, toDate => $toDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getCreatorBlogPosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
id = id_example # String | The GUID of the creator to retrieve posts from. (default to null)
channel = channel_example # String | The id of a creator's specific channel from which to retrieve posts. (optional) (default to null)
limit = 56 # Integer | The maximum number of posts to return. (optional) (default to null)
fetchAfter = 56 # Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results. (optional) (default to null)
search = search_example # String | Search filter to look for specific posts. (optional) (default to null)
tags =  # array[String] | An array of tags to search against, possibly in addition to `search`. (optional) (default to null)
hasVideo = true # Boolean | If true, include blog posts with video attachments. (optional) (default to null)
hasAudio = true # Boolean | If true, include blog posts with audio attachments. (optional) (default to null)
hasPicture = true # Boolean | If true, include blog posts with picture attachments. (optional) (default to null)
hasText = true # Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results. (optional) (default to null)
sort = sort_example # String | `DESC` = Newest First. `ASC` = Oldest First. (optional) (default to null)
fromDuration = 56 # Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional) (default to null)
toDuration = 56 # Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional) (default to null)
fromDate = 2022-07-24T07:00:00.001Z # Date | Include posts where the publication date is on or after this filter date. (optional) (default to null)
toDate = 2022-07-24T07:00:00.001Z # Date | Include posts where the publication date is on or before this filter date. (optional) (default to null)

try:
    # Get Creator Blog Posts
    api_response = api_instance.get_creator_blog_posts(id, channel=channel, limit=limit, fetchAfter=fetchAfter, search=search, tags=tags, hasVideo=hasVideo, hasAudio=hasAudio, hasPicture=hasPicture, hasText=hasText, sort=sort, fromDuration=fromDuration, toDuration=toDuration, fromDate=fromDate, toDate=toDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getCreatorBlogPosts: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let id = id_example; // String
    let channel = channel_example; // String
    let limit = 56; // Integer
    let fetchAfter = 56; // Integer
    let search = search_example; // String
    let tags = ; // array[String]
    let hasVideo = true; // Boolean
    let hasAudio = true; // Boolean
    let hasPicture = true; // Boolean
    let hasText = true; // Boolean
    let sort = sort_example; // String
    let fromDuration = 56; // Integer
    let toDuration = 56; // Integer
    let fromDate = 2022-07-24T07:00:00.001Z; // Date
    let toDate = 2022-07-24T07:00:00.001Z; // Date

    let mut context = ContentV3Api::Context::default();
    let result = client.getCreatorBlogPosts(id, channel, limit, fetchAfter, search, tags, hasVideo, hasAudio, hasPicture, hasText, sort, fromDuration, toDuration, fromDate, toDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the creator to retrieve posts from.
Required
channel
String
The id of a creator's specific channel from which to retrieve posts.
limit
Integer
The maximum number of posts to return.
fetchAfter
Integer
The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
search
tags
array[String]
An array of tags to search against, possibly in addition to `search`.
hasVideo
Boolean
If true, include blog posts with video attachments.
hasAudio
Boolean
If true, include blog posts with audio attachments.
hasPicture
Boolean
If true, include blog posts with picture attachments.
hasText
Boolean
If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery. This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
sort
String
`DESC` = Newest First. `ASC` = Oldest First.
fromDuration
Integer
Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
toDuration
Integer
Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
fromDate
Date (date-time)
Include posts where the publication date is on or after this filter date.
toDate
Date (date-time)
Include posts where the publication date is on or before this filter date.

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getMultiCreatorBlogPosts

Get Multi Creator Blog Posts

Retrieve paginated blog posts from multiple creators for the home page. Example query: https://www.floatplane.com/api/v3/content/creator/list?ids[0]=59f94c0bdd241b70349eb72b&limit=20&fetchAfter[0][creatorId]=59f94c0bdd241b70349eb72b&fetchAfter[0][blogPostId]=B4WsyLnybS&fetchAfter[0][moreFetchable]=true


/api/v3/content/creator/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/creator/list?ids=&limit=56&fetchAfter="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        array[String] ids = ; // array[String] | The GUID(s) of the creator(s) to retrieve posts from.
        Integer limit = 56; // Integer | The maximum number of posts to retrieve.
        array[ContentCreatorListLastItems] fetchAfter = ; // array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.

        try {
            ContentCreatorListV3Response result = apiInstance.getMultiCreatorBlogPosts(ids, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getMultiCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        array[String] ids = ; // array[String] | The GUID(s) of the creator(s) to retrieve posts from.
        Integer limit = 56; // Integer | The maximum number of posts to retrieve.
        array[ContentCreatorListLastItems] fetchAfter = ; // array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.

        try {
            ContentCreatorListV3Response result = apiInstance.getMultiCreatorBlogPosts(ids, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getMultiCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
array[String] *ids = ; // The GUID(s) of the creator(s) to retrieve posts from. (default to null)
Integer *limit = 56; // The maximum number of posts to retrieve. (default to null)
array[ContentCreatorListLastItems] *fetchAfter = ; // For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`. (optional) (default to null)

// Get Multi Creator Blog Posts
[apiInstance getMultiCreatorBlogPostsWith:ids
    limit:limit
    fetchAfter:fetchAfter
              completionHandler: ^(ContentCreatorListV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var ids = ; // {array[String]} The GUID(s) of the creator(s) to retrieve posts from.
var limit = 56; // {Integer} The maximum number of posts to retrieve.
var opts = {
  'fetchAfter':  // {array[ContentCreatorListLastItems]} For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMultiCreatorBlogPosts(ids, limit, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var ids = new array[String](); // array[String] | The GUID(s) of the creator(s) to retrieve posts from. (default to null)
            var limit = 56;  // Integer | The maximum number of posts to retrieve. (default to null)
            var fetchAfter = new array[ContentCreatorListLastItems](); // array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`. (optional)  (default to null)

            try {
                // Get Multi Creator Blog Posts
                ContentCreatorListV3Response result = apiInstance.getMultiCreatorBlogPosts(ids, limit, fetchAfter);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getMultiCreatorBlogPosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$ids = ; // array[String] | The GUID(s) of the creator(s) to retrieve posts from.
$limit = 56; // Integer | The maximum number of posts to retrieve.
$fetchAfter = ; // array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.

try {
    $result = $api_instance->getMultiCreatorBlogPosts($ids, $limit, $fetchAfter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getMultiCreatorBlogPosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $ids = []; # array[String] | The GUID(s) of the creator(s) to retrieve posts from.
my $limit = 56; # Integer | The maximum number of posts to retrieve.
my $fetchAfter = []; # array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.

eval {
    my $result = $api_instance->getMultiCreatorBlogPosts(ids => $ids, limit => $limit, fetchAfter => $fetchAfter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getMultiCreatorBlogPosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
ids =  # array[String] | The GUID(s) of the creator(s) to retrieve posts from. (default to null)
limit = 56 # Integer | The maximum number of posts to retrieve. (default to null)
fetchAfter =  # array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`. (optional) (default to null)

try:
    # Get Multi Creator Blog Posts
    api_response = api_instance.get_multi_creator_blog_posts(ids, limit, fetchAfter=fetchAfter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getMultiCreatorBlogPosts: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let ids = ; // array[String]
    let limit = 56; // Integer
    let fetchAfter = ; // array[ContentCreatorListLastItems]

    let mut context = ContentV3Api::Context::default();
    let result = client.getMultiCreatorBlogPosts(ids, limit, fetchAfter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
ids*
array[String]
The GUID(s) of the creator(s) to retrieve posts from.
Required
limit*
Integer
The maximum number of posts to retrieve.
Required
fetchAfter
array[ContentCreatorListLastItems]
For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getPictureContent

Get Picture Content

Retrieve more information on a picture attachment from a blog post in order to consume the picture content.


/api/v3/content/picture

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/picture?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the picture attachment object, from the `BlogPostModelV3`.

        try {
            ContentPictureV3Response result = apiInstance.getPictureContent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getPictureContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the picture attachment object, from the `BlogPostModelV3`.

        try {
            ContentPictureV3Response result = apiInstance.getPictureContent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getPictureContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
String *id = id_example; // The ID of the picture attachment object, from the `BlogPostModelV3`. (default to null)

// Get Picture Content
[apiInstance getPictureContentWith:id
              completionHandler: ^(ContentPictureV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var id = id_example; // {String} The ID of the picture attachment object, from the `BlogPostModelV3`.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPictureContent(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var id = id_example;  // String | The ID of the picture attachment object, from the `BlogPostModelV3`. (default to null)

            try {
                // Get Picture Content
                ContentPictureV3Response result = apiInstance.getPictureContent(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getPictureContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$id = id_example; // String | The ID of the picture attachment object, from the `BlogPostModelV3`.

try {
    $result = $api_instance->getPictureContent($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getPictureContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $id = id_example; # String | The ID of the picture attachment object, from the `BlogPostModelV3`.

eval {
    my $result = $api_instance->getPictureContent(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getPictureContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
id = id_example # String | The ID of the picture attachment object, from the `BlogPostModelV3`. (default to null)

try:
    # Get Picture Content
    api_response = api_instance.get_picture_content(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getPictureContent: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = ContentV3Api::Context::default();
    let result = client.getPictureContent(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The ID of the picture attachment object, from the `BlogPostModelV3`.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getPictureUrl

Get Picture Url

TODO - Not used in Floatplane code.


/api/v3/content/picture/url

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/picture/url"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getPictureUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getPictureUrl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getPictureUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getPictureUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];

// Get Picture Url
[apiInstance getPictureUrlWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPictureUrl(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();

            try {
                // Get Picture Url
                oas_any_type_not_mapped result = apiInstance.getPictureUrl();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getPictureUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();

try {
    $result = $api_instance->getPictureUrl();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getPictureUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();

eval {
    my $result = $api_instance->getPictureUrl();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getPictureUrl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()

try:
    # Get Picture Url
    api_response = api_instance.get_picture_url()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getPictureUrl: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {

    let mut context = ContentV3Api::Context::default();
    let result = client.getPictureUrl(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getProgress

Get Progress

Batch retrieval of watch progress values for blog posts. This API is useful for showing progress of a list of blog posts shown on the screen to the user. When retrieving a list of blog posts, the media attachments only include the identifier; when retrieving full details of a blog post, the attachments include more information, but still fail to return the progress of the media. Only when pulling the full video/audio content does the progress get included in the response. Thus, the recommended approach is to pull paginated results of blog posts first, as usual, and then to call this endpoint to retrieve progress values for each blog post to show in some capacity, usually on the thumbnail as a progress bar on the bottom. Note that the progress values returned in this endpoint are different from the update progress endpoint and the values returned in video/audio attachments. While the latter are measured in seconds, this endpoint returns progress as a percentage of the media's total duration. It is presumed that the progress returned is from the first attachment in the blog post's `attachmentOrder` that is either a video or audio attachment. Because this returns progress as an integer percentage (0 to 100), it is not recommended to use this particular value for jumping to a timestamp in the media when resuming playback, as the rounded number may be off by plus/minus several seconds in actual playback. Use the actual attachment progress, measured in seconds, instead.


/api/v3/content/get/progress

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/content/get/progress" \
 -d '{
  "ids" : [ "ids", "ids" ],
  "contentType" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        GetProgressRequest getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // GetProgressRequest | 

        try {
            array[GetProgressResponse_inner] result = apiInstance.getProgress(getProgressRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getProgress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        GetProgressRequest getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // GetProgressRequest | 

        try {
            array[GetProgressResponse_inner] result = apiInstance.getProgress(getProgressRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getProgress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
GetProgressRequest *getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // 

// Get Progress
[apiInstance getProgressWith:getProgressRequest
              completionHandler: ^(array[GetProgressResponse_inner] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // {GetProgressRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProgress(getProgressRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var getProgressRequest = new GetProgressRequest(); // GetProgressRequest | 

            try {
                // Get Progress
                array[GetProgressResponse_inner] result = apiInstance.getProgress(getProgressRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getProgress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // GetProgressRequest | 

try {
    $result = $api_instance->getProgress($getProgressRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getProgress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $getProgressRequest = WWW::OPenAPIClient::Object::GetProgressRequest->new(); # GetProgressRequest | 

eval {
    my $result = $api_instance->getProgress(getProgressRequest => $getProgressRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getProgress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"} # GetProgressRequest | 

try:
    # Get Progress
    api_response = api_instance.get_progress(getProgressRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getProgress: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // GetProgressRequest

    let mut context = ContentV3Api::Context::default();
    let result = client.getProgress(getProgressRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
getProgressRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getRelatedBlogPosts

Get Related Blog Posts

Retrieve a list of blog posts that are related to the post being viewed.


/api/v3/content/related

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/related?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the originating post.

        try {
            array[BlogPostModelV3] result = apiInstance.getRelatedBlogPosts(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getRelatedBlogPosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the originating post.

        try {
            array[BlogPostModelV3] result = apiInstance.getRelatedBlogPosts(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getRelatedBlogPosts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
String *id = id_example; // The ID of the originating post. (default to null)

// Get Related Blog Posts
[apiInstance getRelatedBlogPostsWith:id
              completionHandler: ^(array[BlogPostModelV3] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var id = id_example; // {String} The ID of the originating post.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRelatedBlogPosts(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var id = id_example;  // String | The ID of the originating post. (default to null)

            try {
                // Get Related Blog Posts
                array[BlogPostModelV3] result = apiInstance.getRelatedBlogPosts(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getRelatedBlogPosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$id = id_example; // String | The ID of the originating post.

try {
    $result = $api_instance->getRelatedBlogPosts($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getRelatedBlogPosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $id = id_example; # String | The ID of the originating post.

eval {
    my $result = $api_instance->getRelatedBlogPosts(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getRelatedBlogPosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
id = id_example # String | The ID of the originating post. (default to null)

try:
    # Get Related Blog Posts
    api_response = api_instance.get_related_blog_posts(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getRelatedBlogPosts: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = ContentV3Api::Context::default();
    let result = client.getRelatedBlogPosts(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The ID of the originating post.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getVideoContent

Get Video Content

Retrieve more information on a video attachment from a blog post in order to consume the video content.


/api/v3/content/video

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/video?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the video attachment object, from the `BlogPostModelV3`.

        try {
            ContentVideoV3Response result = apiInstance.getVideoContent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getVideoContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the video attachment object, from the `BlogPostModelV3`.

        try {
            ContentVideoV3Response result = apiInstance.getVideoContent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getVideoContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
String *id = id_example; // The ID of the video attachment object, from the `BlogPostModelV3`. (default to null)

// Get Video Content
[apiInstance getVideoContentWith:id
              completionHandler: ^(ContentVideoV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var id = id_example; // {String} The ID of the video attachment object, from the `BlogPostModelV3`.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoContent(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var id = id_example;  // String | The ID of the video attachment object, from the `BlogPostModelV3`. (default to null)

            try {
                // Get Video Content
                ContentVideoV3Response result = apiInstance.getVideoContent(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getVideoContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$id = id_example; // String | The ID of the video attachment object, from the `BlogPostModelV3`.

try {
    $result = $api_instance->getVideoContent($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getVideoContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $id = id_example; # String | The ID of the video attachment object, from the `BlogPostModelV3`.

eval {
    my $result = $api_instance->getVideoContent(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getVideoContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
id = id_example # String | The ID of the video attachment object, from the `BlogPostModelV3`. (default to null)

try:
    # Get Video Content
    api_response = api_instance.get_video_content(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getVideoContent: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = ContentV3Api::Context::default();
    let result = client.getVideoContent(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The ID of the video attachment object, from the `BlogPostModelV3`.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


likeContent

Like Content

Toggles the like status on a piece of content. If disliked before, it will turn into a like. If liked before, the like will be removed.


/api/v3/content/like

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/content/like" \
 -d '{
  "id" : "id",
  "contentType" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        ContentLikeV3Request contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

        try {
            array['String'] result = apiInstance.likeContent(contentLikeV3Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#likeContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        ContentLikeV3Request contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

        try {
            array['String'] result = apiInstance.likeContent(contentLikeV3Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#likeContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
ContentLikeV3Request *contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // 

// Like Content
[apiInstance likeContentWith:contentLikeV3Request
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // {ContentLikeV3Request} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.likeContent(contentLikeV3Request, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var contentLikeV3Request = new ContentLikeV3Request(); // ContentLikeV3Request | 

            try {
                // Like Content
                array['String'] result = apiInstance.likeContent(contentLikeV3Request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.likeContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

try {
    $result = $api_instance->likeContent($contentLikeV3Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->likeContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $contentLikeV3Request = WWW::OPenAPIClient::Object::ContentLikeV3Request->new(); # ContentLikeV3Request | 

eval {
    my $result = $api_instance->likeContent(contentLikeV3Request => $contentLikeV3Request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->likeContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"} # ContentLikeV3Request | 

try:
    # Like Content
    api_response = api_instance.like_content(contentLikeV3Request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->likeContent: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request

    let mut context = ContentV3Api::Context::default();
    let result = client.likeContent(contentLikeV3Request, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
contentLikeV3Request *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateProgress

Update Progress

Update the watch progress on a piece of media (usually video or audio), stored as the number of seconds in the media.


/api/v3/content/progress

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: text/plain,application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/content/progress" \
 -d '{
  "progress" : 0,
  "id" : "id",
  "contentType" : "video"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        UpdateProgressRequest updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // UpdateProgressRequest | 

        try {
            'String' result = apiInstance.updateProgress(updateProgressRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#updateProgress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        UpdateProgressRequest updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // UpdateProgressRequest | 

        try {
            'String' result = apiInstance.updateProgress(updateProgressRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#updateProgress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
UpdateProgressRequest *updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // 

// Update Progress
[apiInstance updateProgressWith:updateProgressRequest
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // {UpdateProgressRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProgress(updateProgressRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var updateProgressRequest = new UpdateProgressRequest(); // UpdateProgressRequest | 

            try {
                // Update Progress
                'String' result = apiInstance.updateProgress(updateProgressRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.updateProgress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // UpdateProgressRequest | 

try {
    $result = $api_instance->updateProgress($updateProgressRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->updateProgress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $updateProgressRequest = WWW::OPenAPIClient::Object::UpdateProgressRequest->new(); # UpdateProgressRequest | 

eval {
    my $result = $api_instance->updateProgress(updateProgressRequest => $updateProgressRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->updateProgress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"} # UpdateProgressRequest | 

try:
    # Update Progress
    api_response = api_instance.update_progress(updateProgressRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->updateProgress: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // UpdateProgressRequest

    let mut context = ContentV3Api::Context::default();
    let result = client.updateProgress(updateProgressRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
updateProgressRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CreatorAdministration

addCreatorModeratorByPath

Add Creator Moderator By Path

TODO


/api/v2/creators/{creator}/administration/moderators/add

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creators/{creator}/administration/moderators/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationApi;

import java.io.File;
import java.util.*;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#addCreatorModeratorByPath");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationApi;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#addCreatorModeratorByPath");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorAdministrationApi *apiInstance = [[CreatorAdministrationApi alloc] init];
String *creator = creator_example; //  (default to null)

// Add Creator Moderator By Path
[apiInstance addCreatorModeratorByPathWith:creator
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorAdministrationApi()
var creator = creator_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCreatorModeratorByPath(creator, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationApi();
            var creator = creator_example;  // String |  (default to null)

            try {
                // Add Creator Moderator By Path
                oas_any_type_not_mapped result = apiInstance.addCreatorModeratorByPath(creator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationApi.addCreatorModeratorByPath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationApi();
$creator = creator_example; // String | 

try {
    $result = $api_instance->addCreatorModeratorByPath($creator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationApi->addCreatorModeratorByPath: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationApi->new();
my $creator = creator_example; # String | 

eval {
    my $result = $api_instance->addCreatorModeratorByPath(creator => $creator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationApi->addCreatorModeratorByPath: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationApi()
creator = creator_example # String |  (default to null)

try:
    # Add Creator Moderator By Path
    api_response = api_instance.add_creator_moderator_by_path(creator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationApi->addCreatorModeratorByPath: %s\n" % e)
extern crate CreatorAdministrationApi;

pub fn main() {
    let creator = creator_example; // String

    let mut context = CreatorAdministrationApi::Context::default();
    let result = client.addCreatorModeratorByPath(creator, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
creator*
String
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listModerators

List Moderators

TODO


/api/v2/creator/administration/moderators/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/administration/moderators/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationApi;

import java.io.File;
import java.util.*;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();

        try {
            oas_any_type_not_mapped result = apiInstance.listModerators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#listModerators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationApi;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();

        try {
            oas_any_type_not_mapped result = apiInstance.listModerators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#listModerators");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorAdministrationApi *apiInstance = [[CreatorAdministrationApi alloc] init];

// List Moderators
[apiInstance listModeratorsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorAdministrationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModerators(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationApi();

            try {
                // List Moderators
                oas_any_type_not_mapped result = apiInstance.listModerators();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationApi.listModerators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationApi();

try {
    $result = $api_instance->listModerators();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationApi->listModerators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationApi->new();

eval {
    my $result = $api_instance->listModerators();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationApi->listModerators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationApi()

try:
    # List Moderators
    api_response = api_instance.list_moderators()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationApi->listModerators: %s\n" % e)
extern crate CreatorAdministrationApi;

pub fn main() {

    let mut context = CreatorAdministrationApi::Context::default();
    let result = client.listModerators(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listModeratorsByPath

List Moderators By Path

TODO


/api/v2/creators/{creator}/administration/moderators/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creators/{creator}/administration/moderators/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationApi;

import java.io.File;
import java.util.*;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.listModeratorsByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#listModeratorsByPath");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationApi;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.listModeratorsByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#listModeratorsByPath");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorAdministrationApi *apiInstance = [[CreatorAdministrationApi alloc] init];
String *creator = creator_example; //  (default to null)

// List Moderators By Path
[apiInstance listModeratorsByPathWith:creator
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorAdministrationApi()
var creator = creator_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModeratorsByPath(creator, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationApi();
            var creator = creator_example;  // String |  (default to null)

            try {
                // List Moderators By Path
                oas_any_type_not_mapped result = apiInstance.listModeratorsByPath(creator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationApi.listModeratorsByPath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationApi();
$creator = creator_example; // String | 

try {
    $result = $api_instance->listModeratorsByPath($creator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationApi->listModeratorsByPath: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationApi->new();
my $creator = creator_example; # String | 

eval {
    my $result = $api_instance->listModeratorsByPath(creator => $creator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationApi->listModeratorsByPath: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationApi()
creator = creator_example # String |  (default to null)

try:
    # List Moderators By Path
    api_response = api_instance.list_moderators_by_path(creator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationApi->listModeratorsByPath: %s\n" % e)
extern crate CreatorAdministrationApi;

pub fn main() {
    let creator = creator_example; // String

    let mut context = CreatorAdministrationApi::Context::default();
    let result = client.listModeratorsByPath(creator, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
creator*
String
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


removeCreatorModeratorAdmin

Remove Creator Moderator

TODO


/api/v2/creator/administration/moderators/remove

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/administration/moderators/remove"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationApi;

import java.io.File;
import java.util.*;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();

        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#removeCreatorModeratorAdmin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationApi;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();

        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#removeCreatorModeratorAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorAdministrationApi *apiInstance = [[CreatorAdministrationApi alloc] init];

// Remove Creator Moderator
[apiInstance removeCreatorModeratorAdminWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorAdministrationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeCreatorModeratorAdmin(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationApi();

            try {
                // Remove Creator Moderator
                oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorAdmin();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationApi.removeCreatorModeratorAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationApi();

try {
    $result = $api_instance->removeCreatorModeratorAdmin();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationApi->removeCreatorModeratorAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationApi->new();

eval {
    my $result = $api_instance->removeCreatorModeratorAdmin();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationApi->removeCreatorModeratorAdmin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationApi()

try:
    # Remove Creator Moderator
    api_response = api_instance.remove_creator_moderator_admin()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationApi->removeCreatorModeratorAdmin: %s\n" % e)
extern crate CreatorAdministrationApi;

pub fn main() {

    let mut context = CreatorAdministrationApi::Context::default();
    let result = client.removeCreatorModeratorAdmin(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


removeCreatorModeratorByPath

Remove Creator Moderator By Path

TODO


/api/v2/creators/{creator}/administration/moderators/remove

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creators/{creator}/administration/moderators/remove"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationApi;

import java.io.File;
import java.util.*;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#removeCreatorModeratorByPath");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationApi;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#removeCreatorModeratorByPath");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorAdministrationApi *apiInstance = [[CreatorAdministrationApi alloc] init];
String *creator = creator_example; //  (default to null)

// Remove Creator Moderator By Path
[apiInstance removeCreatorModeratorByPathWith:creator
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorAdministrationApi()
var creator = creator_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeCreatorModeratorByPath(creator, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationApi();
            var creator = creator_example;  // String |  (default to null)

            try {
                // Remove Creator Moderator By Path
                oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorByPath(creator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationApi.removeCreatorModeratorByPath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationApi();
$creator = creator_example; // String | 

try {
    $result = $api_instance->removeCreatorModeratorByPath($creator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationApi->removeCreatorModeratorByPath: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationApi->new();
my $creator = creator_example; # String | 

eval {
    my $result = $api_instance->removeCreatorModeratorByPath(creator => $creator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationApi->removeCreatorModeratorByPath: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationApi()
creator = creator_example # String |  (default to null)

try:
    # Remove Creator Moderator By Path
    api_response = api_instance.remove_creator_moderator_by_path(creator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationApi->removeCreatorModeratorByPath: %s\n" % e)
extern crate CreatorAdministrationApi;

pub fn main() {
    let creator = creator_example; // String

    let mut context = CreatorAdministrationApi::Context::default();
    let result = client.removeCreatorModeratorByPath(creator, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
creator*
String
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CreatorAdministrationV2

addCreatorModeratorAdmin

Add Creator Moderator

TODO


/api/v2/creator/administration/moderators/add

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/administration/moderators/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationV2Api;

import java.io.File;
import java.util.*;

public class CreatorAdministrationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorAdministrationV2Api apiInstance = new CreatorAdministrationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationV2Api#addCreatorModeratorAdmin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationV2Api;

public class CreatorAdministrationV2ApiExample {
    public static void main(String[] args) {
        CreatorAdministrationV2Api apiInstance = new CreatorAdministrationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationV2Api#addCreatorModeratorAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorAdministrationV2Api *apiInstance = [[CreatorAdministrationV2Api alloc] init];

// Add Creator Moderator
[apiInstance addCreatorModeratorAdminWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorAdministrationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCreatorModeratorAdmin(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationV2Api();

            try {
                // Add Creator Moderator
                oas_any_type_not_mapped result = apiInstance.addCreatorModeratorAdmin();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationV2Api.addCreatorModeratorAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationV2Api();

try {
    $result = $api_instance->addCreatorModeratorAdmin();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationV2Api->addCreatorModeratorAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationV2Api->new();

eval {
    my $result = $api_instance->addCreatorModeratorAdmin();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationV2Api->addCreatorModeratorAdmin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationV2Api()

try:
    # Add Creator Moderator
    api_response = api_instance.add_creator_moderator_admin()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationV2Api->addCreatorModeratorAdmin: %s\n" % e)
extern crate CreatorAdministrationV2Api;

pub fn main() {

    let mut context = CreatorAdministrationV2Api::Context::default();
    let result = client.addCreatorModeratorAdmin(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CreatorAgreementV2

confirmAgreement

Confirm Agreement

TODO


/api/v2/api/creator/agreement/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/api/creator/agreement/confirm"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAgreementV2Api;

import java.io.File;
import java.util.*;

public class CreatorAgreementV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorAgreementV2Api apiInstance = new CreatorAgreementV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.confirmAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAgreementV2Api#confirmAgreement");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAgreementV2Api;

public class CreatorAgreementV2ApiExample {
    public static void main(String[] args) {
        CreatorAgreementV2Api apiInstance = new CreatorAgreementV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.confirmAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAgreementV2Api#confirmAgreement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorAgreementV2Api *apiInstance = [[CreatorAgreementV2Api alloc] init];

// Confirm Agreement
[apiInstance confirmAgreementWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorAgreementV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmAgreement(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorAgreementV2Api();

            try {
                // Confirm Agreement
                oas_any_type_not_mapped result = apiInstance.confirmAgreement();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAgreementV2Api.confirmAgreement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAgreementV2Api();

try {
    $result = $api_instance->confirmAgreement();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAgreementV2Api->confirmAgreement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAgreementV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAgreementV2Api->new();

eval {
    my $result = $api_instance->confirmAgreement();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAgreementV2Api->confirmAgreement: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAgreementV2Api()

try:
    # Confirm Agreement
    api_response = api_instance.confirm_agreement()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAgreementV2Api->confirmAgreement: %s\n" % e)
extern crate CreatorAgreementV2Api;

pub fn main() {

    let mut context = CreatorAgreementV2Api::Context::default();
    let result = client.confirmAgreement(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getAgreement

Get Agreement

TODO


/api/v2/api/creator/agreement/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/api/creator/agreement/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAgreementV2Api;

import java.io.File;
import java.util.*;

public class CreatorAgreementV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorAgreementV2Api apiInstance = new CreatorAgreementV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAgreementV2Api#getAgreement");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAgreementV2Api;

public class CreatorAgreementV2ApiExample {
    public static void main(String[] args) {
        CreatorAgreementV2Api apiInstance = new CreatorAgreementV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAgreementV2Api#getAgreement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorAgreementV2Api *apiInstance = [[CreatorAgreementV2Api alloc] init];

// Get Agreement
[apiInstance getAgreementWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorAgreementV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAgreement(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorAgreementV2Api();

            try {
                // Get Agreement
                oas_any_type_not_mapped result = apiInstance.getAgreement();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAgreementV2Api.getAgreement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAgreementV2Api();

try {
    $result = $api_instance->getAgreement();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAgreementV2Api->getAgreement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAgreementV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAgreementV2Api->new();

eval {
    my $result = $api_instance->getAgreement();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAgreementV2Api->getAgreement: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAgreementV2Api()

try:
    # Get Agreement
    api_response = api_instance.get_agreement()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAgreementV2Api->getAgreement: %s\n" % e)
extern crate CreatorAgreementV2Api;

pub fn main() {

    let mut context = CreatorAgreementV2Api::Context::default();
    let result = client.getAgreement(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CreatorPlanFeatureLevelsV2

calculateCreatorPlanFeatureCosts

Calculate Creator Plan Feature Costs

TODO


/api/v2/creatorplanfeaturelevel/cost

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creatorplanfeaturelevel/cost"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorPlanFeatureLevelsV2Api;

import java.io.File;
import java.util.*;

public class CreatorPlanFeatureLevelsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorPlanFeatureLevelsV2Api apiInstance = new CreatorPlanFeatureLevelsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.calculateCreatorPlanFeatureCosts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsV2Api#calculateCreatorPlanFeatureCosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorPlanFeatureLevelsV2Api;

public class CreatorPlanFeatureLevelsV2ApiExample {
    public static void main(String[] args) {
        CreatorPlanFeatureLevelsV2Api apiInstance = new CreatorPlanFeatureLevelsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.calculateCreatorPlanFeatureCosts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsV2Api#calculateCreatorPlanFeatureCosts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorPlanFeatureLevelsV2Api *apiInstance = [[CreatorPlanFeatureLevelsV2Api alloc] init];

// Calculate Creator Plan Feature Costs
[apiInstance calculateCreatorPlanFeatureCostsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorPlanFeatureLevelsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculateCreatorPlanFeatureCosts(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorPlanFeatureLevelsV2Api();

            try {
                // Calculate Creator Plan Feature Costs
                oas_any_type_not_mapped result = apiInstance.calculateCreatorPlanFeatureCosts();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorPlanFeatureLevelsV2Api.calculateCreatorPlanFeatureCosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorPlanFeatureLevelsV2Api();

try {
    $result = $api_instance->calculateCreatorPlanFeatureCosts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorPlanFeatureLevelsV2Api->calculateCreatorPlanFeatureCosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorPlanFeatureLevelsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorPlanFeatureLevelsV2Api->new();

eval {
    my $result = $api_instance->calculateCreatorPlanFeatureCosts();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorPlanFeatureLevelsV2Api->calculateCreatorPlanFeatureCosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorPlanFeatureLevelsV2Api()

try:
    # Calculate Creator Plan Feature Costs
    api_response = api_instance.calculate_creator_plan_feature_costs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorPlanFeatureLevelsV2Api->calculateCreatorPlanFeatureCosts: %s\n" % e)
extern crate CreatorPlanFeatureLevelsV2Api;

pub fn main() {

    let mut context = CreatorPlanFeatureLevelsV2Api::Context::default();
    let result = client.calculateCreatorPlanFeatureCosts(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listCreatorPlanFeatureLevels

List Creator Plan Feature Levels

TODO


/api/v2/creatorplanfeaturelevel/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creatorplanfeaturelevel/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorPlanFeatureLevelsV2Api;

import java.io.File;
import java.util.*;

public class CreatorPlanFeatureLevelsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorPlanFeatureLevelsV2Api apiInstance = new CreatorPlanFeatureLevelsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorPlanFeatureLevels();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsV2Api#listCreatorPlanFeatureLevels");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorPlanFeatureLevelsV2Api;

public class CreatorPlanFeatureLevelsV2ApiExample {
    public static void main(String[] args) {
        CreatorPlanFeatureLevelsV2Api apiInstance = new CreatorPlanFeatureLevelsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorPlanFeatureLevels();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsV2Api#listCreatorPlanFeatureLevels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorPlanFeatureLevelsV2Api *apiInstance = [[CreatorPlanFeatureLevelsV2Api alloc] init];

// List Creator Plan Feature Levels
[apiInstance listCreatorPlanFeatureLevelsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorPlanFeatureLevelsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorPlanFeatureLevels(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorPlanFeatureLevelsV2Api();

            try {
                // List Creator Plan Feature Levels
                oas_any_type_not_mapped result = apiInstance.listCreatorPlanFeatureLevels();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorPlanFeatureLevelsV2Api.listCreatorPlanFeatureLevels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorPlanFeatureLevelsV2Api();

try {
    $result = $api_instance->listCreatorPlanFeatureLevels();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorPlanFeatureLevelsV2Api->listCreatorPlanFeatureLevels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorPlanFeatureLevelsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorPlanFeatureLevelsV2Api->new();

eval {
    my $result = $api_instance->listCreatorPlanFeatureLevels();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorPlanFeatureLevelsV2Api->listCreatorPlanFeatureLevels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorPlanFeatureLevelsV2Api()

try:
    # List Creator Plan Feature Levels
    api_response = api_instance.list_creator_plan_feature_levels()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorPlanFeatureLevelsV2Api->listCreatorPlanFeatureLevels: %s\n" % e)
extern crate CreatorPlanFeatureLevelsV2Api;

pub fn main() {

    let mut context = CreatorPlanFeatureLevelsV2Api::Context::default();
    let result = client.listCreatorPlanFeatureLevels(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


planFeatureLevels

Plan Feature Levels

TODO


/api/v2/plan/feature/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/plan/feature/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorPlanFeatureLevelsV2Api;

import java.io.File;
import java.util.*;

public class CreatorPlanFeatureLevelsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorPlanFeatureLevelsV2Api apiInstance = new CreatorPlanFeatureLevelsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.planFeatureLevels();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsV2Api#planFeatureLevels");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorPlanFeatureLevelsV2Api;

public class CreatorPlanFeatureLevelsV2ApiExample {
    public static void main(String[] args) {
        CreatorPlanFeatureLevelsV2Api apiInstance = new CreatorPlanFeatureLevelsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.planFeatureLevels();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsV2Api#planFeatureLevels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorPlanFeatureLevelsV2Api *apiInstance = [[CreatorPlanFeatureLevelsV2Api alloc] init];

// Plan Feature Levels
[apiInstance planFeatureLevelsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorPlanFeatureLevelsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.planFeatureLevels(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorPlanFeatureLevelsV2Api();

            try {
                // Plan Feature Levels
                oas_any_type_not_mapped result = apiInstance.planFeatureLevels();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorPlanFeatureLevelsV2Api.planFeatureLevels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorPlanFeatureLevelsV2Api();

try {
    $result = $api_instance->planFeatureLevels();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorPlanFeatureLevelsV2Api->planFeatureLevels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorPlanFeatureLevelsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorPlanFeatureLevelsV2Api->new();

eval {
    my $result = $api_instance->planFeatureLevels();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorPlanFeatureLevelsV2Api->planFeatureLevels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorPlanFeatureLevelsV2Api()

try:
    # Plan Feature Levels
    api_response = api_instance.plan_feature_levels()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorPlanFeatureLevelsV2Api->planFeatureLevels: %s\n" % e)
extern crate CreatorPlanFeatureLevelsV2Api;

pub fn main() {

    let mut context = CreatorPlanFeatureLevelsV2Api::Context::default();
    let result = client.planFeatureLevels(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CreatorSubscriptionPlanV2

getCreatorSubInfoPublic

Get Creator Sub Info Public

Retrieve detailed information about a creator's subscription plans and their subscriber count.


/api/v2/plan/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/plan/info?creatorId=creatorId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorSubscriptionPlanV2Api;

import java.io.File;
import java.util.*;

public class CreatorSubscriptionPlanV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorSubscriptionPlanV2Api apiInstance = new CreatorSubscriptionPlanV2Api();
        String creatorId = creatorId_example; // String | The GUID for the creator being search.

        try {
            PlanInfoV2Response result = apiInstance.getCreatorSubInfoPublic(creatorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV2Api#getCreatorSubInfoPublic");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorSubscriptionPlanV2Api;

public class CreatorSubscriptionPlanV2ApiExample {
    public static void main(String[] args) {
        CreatorSubscriptionPlanV2Api apiInstance = new CreatorSubscriptionPlanV2Api();
        String creatorId = creatorId_example; // String | The GUID for the creator being search.

        try {
            PlanInfoV2Response result = apiInstance.getCreatorSubInfoPublic(creatorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV2Api#getCreatorSubInfoPublic");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorSubscriptionPlanV2Api *apiInstance = [[CreatorSubscriptionPlanV2Api alloc] init];
String *creatorId = creatorId_example; // The GUID for the creator being search. (default to null)

// Get Creator Sub Info Public
[apiInstance getCreatorSubInfoPublicWith:creatorId
              completionHandler: ^(PlanInfoV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorSubscriptionPlanV2Api()
var creatorId = creatorId_example; // {String} The GUID for the creator being search.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorSubInfoPublic(creatorId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorSubscriptionPlanV2Api();
            var creatorId = creatorId_example;  // String | The GUID for the creator being search. (default to null)

            try {
                // Get Creator Sub Info Public
                PlanInfoV2Response result = apiInstance.getCreatorSubInfoPublic(creatorId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorSubscriptionPlanV2Api.getCreatorSubInfoPublic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorSubscriptionPlanV2Api();
$creatorId = creatorId_example; // String | The GUID for the creator being search.

try {
    $result = $api_instance->getCreatorSubInfoPublic($creatorId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorSubscriptionPlanV2Api->getCreatorSubInfoPublic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorSubscriptionPlanV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorSubscriptionPlanV2Api->new();
my $creatorId = creatorId_example; # String | The GUID for the creator being search.

eval {
    my $result = $api_instance->getCreatorSubInfoPublic(creatorId => $creatorId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorSubscriptionPlanV2Api->getCreatorSubInfoPublic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorSubscriptionPlanV2Api()
creatorId = creatorId_example # String | The GUID for the creator being search. (default to null)

try:
    # Get Creator Sub Info Public
    api_response = api_instance.get_creator_sub_info_public(creatorId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorSubscriptionPlanV2Api->getCreatorSubInfoPublic: %s\n" % e)
extern crate CreatorSubscriptionPlanV2Api;

pub fn main() {
    let creatorId = creatorId_example; // String

    let mut context = CreatorSubscriptionPlanV2Api::Context::default();
    let result = client.getCreatorSubInfoPublic(creatorId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorId*
String
The GUID for the creator being search.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listSubscriptionPlans

List Subscription Plans

TODO - Not used in Floatplane code.


/api/v2/plan/list

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/plan/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorSubscriptionPlanV2Api;

import java.io.File;
import java.util.*;

public class CreatorSubscriptionPlanV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorSubscriptionPlanV2Api apiInstance = new CreatorSubscriptionPlanV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listSubscriptionPlans();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV2Api#listSubscriptionPlans");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorSubscriptionPlanV2Api;

public class CreatorSubscriptionPlanV2ApiExample {
    public static void main(String[] args) {
        CreatorSubscriptionPlanV2Api apiInstance = new CreatorSubscriptionPlanV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listSubscriptionPlans();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV2Api#listSubscriptionPlans");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorSubscriptionPlanV2Api *apiInstance = [[CreatorSubscriptionPlanV2Api alloc] init];

// List Subscription Plans
[apiInstance listSubscriptionPlansWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorSubscriptionPlanV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSubscriptionPlans(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorSubscriptionPlanV2Api();

            try {
                // List Subscription Plans
                oas_any_type_not_mapped result = apiInstance.listSubscriptionPlans();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorSubscriptionPlanV2Api.listSubscriptionPlans: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorSubscriptionPlanV2Api();

try {
    $result = $api_instance->listSubscriptionPlans();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorSubscriptionPlanV2Api->listSubscriptionPlans: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorSubscriptionPlanV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorSubscriptionPlanV2Api->new();

eval {
    my $result = $api_instance->listSubscriptionPlans();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorSubscriptionPlanV2Api->listSubscriptionPlans: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorSubscriptionPlanV2Api()

try:
    # List Subscription Plans
    api_response = api_instance.list_subscription_plans()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorSubscriptionPlanV2Api->listSubscriptionPlans: %s\n" % e)
extern crate CreatorSubscriptionPlanV2Api;

pub fn main() {

    let mut context = CreatorSubscriptionPlanV2Api::Context::default();
    let result = client.listSubscriptionPlans(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


publishSubscriptionPlan

Publish Subscription Plan

TODO


/api/v2/plan/publish

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/plan/publish"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorSubscriptionPlanV2Api;

import java.io.File;
import java.util.*;

public class CreatorSubscriptionPlanV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorSubscriptionPlanV2Api apiInstance = new CreatorSubscriptionPlanV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.publishSubscriptionPlan();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV2Api#publishSubscriptionPlan");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorSubscriptionPlanV2Api;

public class CreatorSubscriptionPlanV2ApiExample {
    public static void main(String[] args) {
        CreatorSubscriptionPlanV2Api apiInstance = new CreatorSubscriptionPlanV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.publishSubscriptionPlan();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV2Api#publishSubscriptionPlan");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorSubscriptionPlanV2Api *apiInstance = [[CreatorSubscriptionPlanV2Api alloc] init];

// Publish Subscription Plan
[apiInstance publishSubscriptionPlanWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorSubscriptionPlanV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publishSubscriptionPlan(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorSubscriptionPlanV2Api();

            try {
                // Publish Subscription Plan
                oas_any_type_not_mapped result = apiInstance.publishSubscriptionPlan();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorSubscriptionPlanV2Api.publishSubscriptionPlan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorSubscriptionPlanV2Api();

try {
    $result = $api_instance->publishSubscriptionPlan();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorSubscriptionPlanV2Api->publishSubscriptionPlan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorSubscriptionPlanV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorSubscriptionPlanV2Api->new();

eval {
    my $result = $api_instance->publishSubscriptionPlan();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorSubscriptionPlanV2Api->publishSubscriptionPlan: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorSubscriptionPlanV2Api()

try:
    # Publish Subscription Plan
    api_response = api_instance.publish_subscription_plan()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorSubscriptionPlanV2Api->publishSubscriptionPlan: %s\n" % e)
extern crate CreatorSubscriptionPlanV2Api;

pub fn main() {

    let mut context = CreatorSubscriptionPlanV2Api::Context::default();
    let result = client.publishSubscriptionPlan(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateSubscriptionPlans

Update Subscription Plans

TODO


/api/v2/plan/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/plan/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorSubscriptionPlanV2Api;

import java.io.File;
import java.util.*;

public class CreatorSubscriptionPlanV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorSubscriptionPlanV2Api apiInstance = new CreatorSubscriptionPlanV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateSubscriptionPlans();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV2Api#updateSubscriptionPlans");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorSubscriptionPlanV2Api;

public class CreatorSubscriptionPlanV2ApiExample {
    public static void main(String[] args) {
        CreatorSubscriptionPlanV2Api apiInstance = new CreatorSubscriptionPlanV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateSubscriptionPlans();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV2Api#updateSubscriptionPlans");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorSubscriptionPlanV2Api *apiInstance = [[CreatorSubscriptionPlanV2Api alloc] init];

// Update Subscription Plans
[apiInstance updateSubscriptionPlansWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorSubscriptionPlanV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateSubscriptionPlans(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorSubscriptionPlanV2Api();

            try {
                // Update Subscription Plans
                oas_any_type_not_mapped result = apiInstance.updateSubscriptionPlans();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorSubscriptionPlanV2Api.updateSubscriptionPlans: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorSubscriptionPlanV2Api();

try {
    $result = $api_instance->updateSubscriptionPlans();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorSubscriptionPlanV2Api->updateSubscriptionPlans: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorSubscriptionPlanV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorSubscriptionPlanV2Api->new();

eval {
    my $result = $api_instance->updateSubscriptionPlans();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorSubscriptionPlanV2Api->updateSubscriptionPlans: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorSubscriptionPlanV2Api()

try:
    # Update Subscription Plans
    api_response = api_instance.update_subscription_plans()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorSubscriptionPlanV2Api->updateSubscriptionPlans: %s\n" % e)
extern crate CreatorSubscriptionPlanV2Api;

pub fn main() {

    let mut context = CreatorSubscriptionPlanV2Api::Context::default();
    let result = client.updateSubscriptionPlans(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CreatorSubscriptionPlanV3

getPlansForContent

Get Plans For Content

TODO


/api/v3/plan/content

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/plan/content"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorSubscriptionPlanV3Api;

import java.io.File;
import java.util.*;

public class CreatorSubscriptionPlanV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorSubscriptionPlanV3Api apiInstance = new CreatorSubscriptionPlanV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getPlansForContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV3Api#getPlansForContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorSubscriptionPlanV3Api;

public class CreatorSubscriptionPlanV3ApiExample {
    public static void main(String[] args) {
        CreatorSubscriptionPlanV3Api apiInstance = new CreatorSubscriptionPlanV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getPlansForContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV3Api#getPlansForContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorSubscriptionPlanV3Api *apiInstance = [[CreatorSubscriptionPlanV3Api alloc] init];

// Get Plans For Content
[apiInstance getPlansForContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorSubscriptionPlanV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlansForContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorSubscriptionPlanV3Api();

            try {
                // Get Plans For Content
                oas_any_type_not_mapped result = apiInstance.getPlansForContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorSubscriptionPlanV3Api.getPlansForContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorSubscriptionPlanV3Api();

try {
    $result = $api_instance->getPlansForContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorSubscriptionPlanV3Api->getPlansForContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorSubscriptionPlanV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorSubscriptionPlanV3Api->new();

eval {
    my $result = $api_instance->getPlansForContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorSubscriptionPlanV3Api->getPlansForContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorSubscriptionPlanV3Api()

try:
    # Get Plans For Content
    api_response = api_instance.get_plans_for_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorSubscriptionPlanV3Api->getPlansForContent: %s\n" % e)
extern crate CreatorSubscriptionPlanV3Api;

pub fn main() {

    let mut context = CreatorSubscriptionPlanV3Api::Context::default();
    let result = client.getPlansForContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CreatorV2

discoverCreatorsV2

Discover Creators

TODO - Not used in Floatplane code.


/api/v2/creator/discover

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/discover"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.discoverCreatorsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#discoverCreatorsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.discoverCreatorsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#discoverCreatorsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];

// Discover Creators
[apiInstance discoverCreatorsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.discoverCreatorsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();

            try {
                // Discover Creators
                oas_any_type_not_mapped result = apiInstance.discoverCreatorsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.discoverCreatorsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();

try {
    $result = $api_instance->discoverCreatorsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->discoverCreatorsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();

eval {
    my $result = $api_instance->discoverCreatorsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->discoverCreatorsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()

try:
    # Discover Creators
    api_response = api_instance.discover_creators_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->discoverCreatorsV2: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {

    let mut context = CreatorV2Api::Context::default();
    let result = client.discoverCreatorsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getChannelInfo

Get Channel Info

TODO


/api/v2/creator/info/get

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/info/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getChannelInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#getChannelInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getChannelInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#getChannelInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];

// Get Channel Info
[apiInstance getChannelInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChannelInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();

            try {
                // Get Channel Info
                oas_any_type_not_mapped result = apiInstance.getChannelInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.getChannelInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();

try {
    $result = $api_instance->getChannelInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->getChannelInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();

eval {
    my $result = $api_instance->getChannelInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->getChannelInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()

try:
    # Get Channel Info
    api_response = api_instance.get_channel_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->getChannelInfo: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {

    let mut context = CreatorV2Api::Context::default();
    let result = client.getChannelInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorInfoByName

Get Info By Name

Retrieve detailed information on one or more creators on Floatplane.


/api/v2/creator/named

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/named?creatorURL="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();
        array[String] creatorURL = ; // array[String] | The string identifer(s) of the creator(s) to be retrieved.

        try {
            array[CreatorModelV2Extended] result = apiInstance.getCreatorInfoByName(creatorURL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#getCreatorInfoByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();
        array[String] creatorURL = ; // array[String] | The string identifer(s) of the creator(s) to be retrieved.

        try {
            array[CreatorModelV2Extended] result = apiInstance.getCreatorInfoByName(creatorURL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#getCreatorInfoByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];
array[String] *creatorURL = ; // The string identifer(s) of the creator(s) to be retrieved. (default to null)

// Get Info By Name
[apiInstance getCreatorInfoByNameWith:creatorURL
              completionHandler: ^(array[CreatorModelV2Extended] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var creatorURL = ; // {array[String]} The string identifer(s) of the creator(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorInfoByName(creatorURL, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();
            var creatorURL = new array[String](); // array[String] | The string identifer(s) of the creator(s) to be retrieved. (default to null)

            try {
                // Get Info By Name
                array[CreatorModelV2Extended] result = apiInstance.getCreatorInfoByName(creatorURL);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.getCreatorInfoByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();
$creatorURL = ; // array[String] | The string identifer(s) of the creator(s) to be retrieved.

try {
    $result = $api_instance->getCreatorInfoByName($creatorURL);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->getCreatorInfoByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();
my $creatorURL = []; # array[String] | The string identifer(s) of the creator(s) to be retrieved.

eval {
    my $result = $api_instance->getCreatorInfoByName(creatorURL => $creatorURL);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->getCreatorInfoByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()
creatorURL =  # array[String] | The string identifer(s) of the creator(s) to be retrieved. (default to null)

try:
    # Get Info By Name
    api_response = api_instance.get_creator_info_by_name(creatorURL)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->getCreatorInfoByName: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {
    let creatorURL = ; // array[String]

    let mut context = CreatorV2Api::Context::default();
    let result = client.getCreatorInfoByName(creatorURL, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorURL*
array[String]
The string identifer(s) of the creator(s) to be retrieved.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getInfo

Get Info

Retrieve detailed information on one or more creators on Floatplane.


/api/v2/creator/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/info?creatorGUID="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();
        array[String] creatorGUID = ; // array[String] | The GUID identifer(s) of the creator(s) to be retrieved.

        try {
            array[CreatorModelV2] result = apiInstance.getInfo(creatorGUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#getInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();
        array[String] creatorGUID = ; // array[String] | The GUID identifer(s) of the creator(s) to be retrieved.

        try {
            array[CreatorModelV2] result = apiInstance.getInfo(creatorGUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#getInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];
array[String] *creatorGUID = ; // The GUID identifer(s) of the creator(s) to be retrieved. (default to null)

// Get Info
[apiInstance getInfoWith:creatorGUID
              completionHandler: ^(array[CreatorModelV2] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var creatorGUID = ; // {array[String]} The GUID identifer(s) of the creator(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInfo(creatorGUID, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();
            var creatorGUID = new array[String](); // array[String] | The GUID identifer(s) of the creator(s) to be retrieved. (default to null)

            try {
                // Get Info
                array[CreatorModelV2] result = apiInstance.getInfo(creatorGUID);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.getInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();
$creatorGUID = ; // array[String] | The GUID identifer(s) of the creator(s) to be retrieved.

try {
    $result = $api_instance->getInfo($creatorGUID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->getInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();
my $creatorGUID = []; # array[String] | The GUID identifer(s) of the creator(s) to be retrieved.

eval {
    my $result = $api_instance->getInfo(creatorGUID => $creatorGUID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->getInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()
creatorGUID =  # array[String] | The GUID identifer(s) of the creator(s) to be retrieved. (default to null)

try:
    # Get Info
    api_response = api_instance.get_info(creatorGUID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->getInfo: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {
    let creatorGUID = ; // array[String]

    let mut context = CreatorV2Api::Context::default();
    let result = client.getInfo(creatorGUID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorGUID*
array[String]
The GUID identifer(s) of the creator(s) to be retrieved.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.



listCreatorCategoriesV2

List Creator Categories

TODO


/api/v2/creatorcategory/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creatorcategory/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#listCreatorCategoriesV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#listCreatorCategoriesV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];

// List Creator Categories
[apiInstance listCreatorCategoriesV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorCategoriesV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();

            try {
                // List Creator Categories
                oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.listCreatorCategoriesV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();

try {
    $result = $api_instance->listCreatorCategoriesV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->listCreatorCategoriesV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();

eval {
    my $result = $api_instance->listCreatorCategoriesV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->listCreatorCategoriesV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()

try:
    # List Creator Categories
    api_response = api_instance.list_creator_categories_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->listCreatorCategoriesV2: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {

    let mut context = CreatorV2Api::Context::default();
    let result = client.listCreatorCategoriesV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listCreators

List Creators

TODO - Not used in Floatplane code.


/api/v2/creator/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#listCreators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#listCreators");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];

// List Creators
[apiInstance listCreatorsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreators(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();

            try {
                // List Creators
                oas_any_type_not_mapped result = apiInstance.listCreators();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.listCreators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();

try {
    $result = $api_instance->listCreators();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->listCreators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();

eval {
    my $result = $api_instance->listCreators();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->listCreators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()

try:
    # List Creators
    api_response = api_instance.list_creators()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->listCreators: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {

    let mut context = CreatorV2Api::Context::default();
    let result = client.listCreators(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listPlaylists

List Playlists

TODO - Not used in Floatplane code.


/api/v2/creator/playlists

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/playlists"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listPlaylists();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#listPlaylists");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listPlaylists();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#listPlaylists");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];

// List Playlists
[apiInstance listPlaylistsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPlaylists(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();

            try {
                // List Playlists
                oas_any_type_not_mapped result = apiInstance.listPlaylists();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.listPlaylists: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();

try {
    $result = $api_instance->listPlaylists();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->listPlaylists: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();

eval {
    my $result = $api_instance->listPlaylists();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->listPlaylists: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()

try:
    # List Playlists
    api_response = api_instance.list_playlists()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->listPlaylists: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {

    let mut context = CreatorV2Api::Context::default();
    let result = client.listPlaylists(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listVideos

List Videos

TODO - Not used in Floatplane code.


/api/v2/creator/videos

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/videos"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#listVideos");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#listVideos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];

// List Videos
[apiInstance listVideosWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listVideos(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();

            try {
                // List Videos
                oas_any_type_not_mapped result = apiInstance.listVideos();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.listVideos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();

try {
    $result = $api_instance->listVideos();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->listVideos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();

eval {
    my $result = $api_instance->listVideos();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->listVideos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()

try:
    # List Videos
    api_response = api_instance.list_videos()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->listVideos: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {

    let mut context = CreatorV2Api::Context::default();
    let result = client.listVideos(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateChannelImage

Update Channel Image

TODO


/api/v2/creator/image/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/image/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateChannelImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#updateChannelImage");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateChannelImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#updateChannelImage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];

// Update Channel Image
[apiInstance updateChannelImageWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateChannelImage(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();

            try {
                // Update Channel Image
                oas_any_type_not_mapped result = apiInstance.updateChannelImage();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.updateChannelImage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();

try {
    $result = $api_instance->updateChannelImage();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->updateChannelImage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();

eval {
    my $result = $api_instance->updateChannelImage();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->updateChannelImage: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()

try:
    # Update Channel Image
    api_response = api_instance.update_channel_image()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->updateChannelImage: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {

    let mut context = CreatorV2Api::Context::default();
    let result = client.updateChannelImage(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateChannelInfo

Update Channel Info

TODO


/api/v2/creator/info/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/info/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateChannelInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#updateChannelInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateChannelInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#updateChannelInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];

// Update Channel Info
[apiInstance updateChannelInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateChannelInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();

            try {
                // Update Channel Info
                oas_any_type_not_mapped result = apiInstance.updateChannelInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.updateChannelInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();

try {
    $result = $api_instance->updateChannelInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->updateChannelInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();

eval {
    my $result = $api_instance->updateChannelInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->updateChannelInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()

try:
    # Update Channel Info
    api_response = api_instance.update_channel_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->updateChannelInfo: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {

    let mut context = CreatorV2Api::Context::default();
    let result = client.updateChannelInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.



CreatorV3

bindCreatorInviteCode

Bind Creator Invite Code

TODO


/api/v3/creator/invite/bind

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/invite/bind"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.bindCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#bindCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.bindCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#bindCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];

// Bind Creator Invite Code
[apiInstance bindCreatorInviteCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.bindCreatorInviteCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();

            try {
                // Bind Creator Invite Code
                oas_any_type_not_mapped result = apiInstance.bindCreatorInviteCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.bindCreatorInviteCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();

try {
    $result = $api_instance->bindCreatorInviteCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->bindCreatorInviteCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();

eval {
    my $result = $api_instance->bindCreatorInviteCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->bindCreatorInviteCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()

try:
    # Bind Creator Invite Code
    api_response = api_instance.bind_creator_invite_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->bindCreatorInviteCode: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {

    let mut context = CreatorV3Api::Context::default();
    let result = client.bindCreatorInviteCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


claimCreatorInviteCode

Claim Creator Invite Code

TODO


/api/v3/creator/invite/claim

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/invite/claim"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.claimCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#claimCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.claimCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#claimCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];

// Claim Creator Invite Code
[apiInstance claimCreatorInviteCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.claimCreatorInviteCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();

            try {
                // Claim Creator Invite Code
                oas_any_type_not_mapped result = apiInstance.claimCreatorInviteCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.claimCreatorInviteCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();

try {
    $result = $api_instance->claimCreatorInviteCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->claimCreatorInviteCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();

eval {
    my $result = $api_instance->claimCreatorInviteCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->claimCreatorInviteCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()

try:
    # Claim Creator Invite Code
    api_response = api_instance.claim_creator_invite_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->claimCreatorInviteCode: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {

    let mut context = CreatorV3Api::Context::default();
    let result = client.claimCreatorInviteCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


discoverCreatorsV3

Discover Creators

TODO


/api/v3/creator/discover

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/discover"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.discoverCreatorsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#discoverCreatorsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.discoverCreatorsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#discoverCreatorsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];

// Discover Creators
[apiInstance discoverCreatorsV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.discoverCreatorsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();

            try {
                // Discover Creators
                oas_any_type_not_mapped result = apiInstance.discoverCreatorsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.discoverCreatorsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();

try {
    $result = $api_instance->discoverCreatorsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->discoverCreatorsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();

eval {
    my $result = $api_instance->discoverCreatorsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->discoverCreatorsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()

try:
    # Discover Creators
    api_response = api_instance.discover_creators_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->discoverCreatorsV3: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {

    let mut context = CreatorV3Api::Context::default();
    let result = client.discoverCreatorsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreator

Get Creator

Retrieve detailed information about a specific creator.


/api/v3/creator/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/info?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();
        String id = id_example; // String | The GUID of the creator being searched.

        try {
            CreatorModelV3 result = apiInstance.getCreator(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();
        String id = id_example; // String | The GUID of the creator being searched.

        try {
            CreatorModelV3 result = apiInstance.getCreator(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];
String *id = id_example; // The GUID of the creator being searched. (default to null)

// Get Creator
[apiInstance getCreatorWith:id
              completionHandler: ^(CreatorModelV3 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var id = id_example; // {String} The GUID of the creator being searched.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreator(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();
            var id = id_example;  // String | The GUID of the creator being searched. (default to null)

            try {
                // Get Creator
                CreatorModelV3 result = apiInstance.getCreator(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.getCreator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();
$id = id_example; // String | The GUID of the creator being searched.

try {
    $result = $api_instance->getCreator($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->getCreator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();
my $id = id_example; # String | The GUID of the creator being searched.

eval {
    my $result = $api_instance->getCreator(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->getCreator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()
id = id_example # String | The GUID of the creator being searched. (default to null)

try:
    # Get Creator
    api_response = api_instance.get_creator(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->getCreator: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = CreatorV3Api::Context::default();
    let result = client.getCreator(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the creator being searched.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorByName

Get Creator By Name

Retrieve detailed information on one or more creators on Floatplane.


/api/v3/creator/named

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/named?creatorURL="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();
        array[String] creatorURL = ; // array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.

        try {
            array[CreatorModelV3] result = apiInstance.getCreatorByName(creatorURL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreatorByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();
        array[String] creatorURL = ; // array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.

        try {
            array[CreatorModelV3] result = apiInstance.getCreatorByName(creatorURL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreatorByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];
array[String] *creatorURL = ; // The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`. (default to null)

// Get Creator By Name
[apiInstance getCreatorByNameWith:creatorURL
              completionHandler: ^(array[CreatorModelV3] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var creatorURL = ; // {array[String]} The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorByName(creatorURL, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();
            var creatorURL = new array[String](); // array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`. (default to null)

            try {
                // Get Creator By Name
                array[CreatorModelV3] result = apiInstance.getCreatorByName(creatorURL);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.getCreatorByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();
$creatorURL = ; // array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.

try {
    $result = $api_instance->getCreatorByName($creatorURL);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->getCreatorByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();
my $creatorURL = []; # array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.

eval {
    my $result = $api_instance->getCreatorByName(creatorURL => $creatorURL);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->getCreatorByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()
creatorURL =  # array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`. (default to null)

try:
    # Get Creator By Name
    api_response = api_instance.get_creator_by_name(creatorURL)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->getCreatorByName: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {
    let creatorURL = ; // array[String]

    let mut context = CreatorV3Api::Context::default();
    let result = client.getCreatorByName(creatorURL, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorURL*
array[String]
The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorInviteCodeInfo

Get Creator Invite Code Info

TODO


/api/v3/creator/invite/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/invite/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreatorInviteCodeInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreatorInviteCodeInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];

// Get Creator Invite Code Info
[apiInstance getCreatorInviteCodeInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorInviteCodeInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();

            try {
                // Get Creator Invite Code Info
                oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.getCreatorInviteCodeInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();

try {
    $result = $api_instance->getCreatorInviteCodeInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->getCreatorInviteCodeInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();

eval {
    my $result = $api_instance->getCreatorInviteCodeInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->getCreatorInviteCodeInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()

try:
    # Get Creator Invite Code Info
    api_response = api_instance.get_creator_invite_code_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->getCreatorInviteCodeInfo: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {

    let mut context = CreatorV3Api::Context::default();
    let result = client.getCreatorInviteCodeInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreators

Get Creators

Retrieve and search for all creators on Floatplane. Useful for creator discovery and filtering.


/api/v3/creator/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/list?search=search_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();
        String search = search_example; // String | Optional search string for finding particular creators on the platform.

        try {
            array[CreatorModelV3] result = apiInstance.getCreators(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();
        String search = search_example; // String | Optional search string for finding particular creators on the platform.

        try {
            array[CreatorModelV3] result = apiInstance.getCreators(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreators");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];
String *search = search_example; // Optional search string for finding particular creators on the platform. (default to null)

// Get Creators
[apiInstance getCreatorsWith:search
              completionHandler: ^(array[CreatorModelV3] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var search = search_example; // {String} Optional search string for finding particular creators on the platform.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreators(search, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();
            var search = search_example;  // String | Optional search string for finding particular creators on the platform. (default to null)

            try {
                // Get Creators
                array[CreatorModelV3] result = apiInstance.getCreators(search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.getCreators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();
$search = search_example; // String | Optional search string for finding particular creators on the platform.

try {
    $result = $api_instance->getCreators($search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->getCreators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();
my $search = search_example; # String | Optional search string for finding particular creators on the platform.

eval {
    my $result = $api_instance->getCreators(search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->getCreators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()
search = search_example # String | Optional search string for finding particular creators on the platform. (default to null)

try:
    # Get Creators
    api_response = api_instance.get_creators(search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->getCreators: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {
    let search = search_example; // String

    let mut context = CreatorV3Api::Context::default();
    let result = client.getCreators(search, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
search*

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listCreatorCategoriesV3

List Creator Categories

TODO - Not used in Floatplane code.


/api/v3/creator/category/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/category/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#listCreatorCategoriesV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#listCreatorCategoriesV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];

// List Creator Categories
[apiInstance listCreatorCategoriesV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorCategoriesV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();

            try {
                // List Creator Categories
                oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.listCreatorCategoriesV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();

try {
    $result = $api_instance->listCreatorCategoriesV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->listCreatorCategoriesV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();

eval {
    my $result = $api_instance->listCreatorCategoriesV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->listCreatorCategoriesV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()

try:
    # List Creator Categories
    api_response = api_instance.list_creator_categories_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->listCreatorCategoriesV3: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {

    let mut context = CreatorV3Api::Context::default();
    let result = client.listCreatorCategoriesV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listCreatorChannelsV3

List Creator Channels

Retrieves a list of channels within the given creator(s).


/api/v3/creator/channels/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/channels/list?ids="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();
        array[String] ids = ; // array[String] | The ids of the creator(s) from which to search for channels.

        try {
            array[ChannelModel] result = apiInstance.listCreatorChannelsV3(ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#listCreatorChannelsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();
        array[String] ids = ; // array[String] | The ids of the creator(s) from which to search for channels.

        try {
            array[ChannelModel] result = apiInstance.listCreatorChannelsV3(ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#listCreatorChannelsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];
array[String] *ids = ; // The ids of the creator(s) from which to search for channels. (default to null)

// List Creator Channels
[apiInstance listCreatorChannelsV3With:ids
              completionHandler: ^(array[ChannelModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var ids = ; // {array[String]} The ids of the creator(s) from which to search for channels.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorChannelsV3(ids, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();
            var ids = new array[String](); // array[String] | The ids of the creator(s) from which to search for channels. (default to null)

            try {
                // List Creator Channels
                array[ChannelModel] result = apiInstance.listCreatorChannelsV3(ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.listCreatorChannelsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();
$ids = ; // array[String] | The ids of the creator(s) from which to search for channels.

try {
    $result = $api_instance->listCreatorChannelsV3($ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->listCreatorChannelsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();
my $ids = []; # array[String] | The ids of the creator(s) from which to search for channels.

eval {
    my $result = $api_instance->listCreatorChannelsV3(ids => $ids);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->listCreatorChannelsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()
ids =  # array[String] | The ids of the creator(s) from which to search for channels. (default to null)

try:
    # List Creator Channels
    api_response = api_instance.list_creator_channels_v3(ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->listCreatorChannelsV3: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {
    let ids = ; // array[String]

    let mut context = CreatorV3Api::Context::default();
    let result = client.listCreatorChannelsV3(ids, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
ids*
array[String]
The ids of the creator(s) from which to search for channels.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


DeliveryV3

getDeliveryInfoV3

Get Delivery Info

Given an video/audio attachment or livestream identifier, retrieves the information necessary to play, download, or livestream the media at various quality levels.


/api/v3/delivery/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/delivery/info?scenario=scenario_example&entityId=entityId_example&outputKind=outputKind_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DeliveryV3Api;

import java.io.File;
import java.util.*;

public class DeliveryV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DeliveryV3Api apiInstance = new DeliveryV3Api();
        String scenario = scenario_example; // String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content
        String entityId = entityId_example; // String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
        String outputKind = outputKind_example; // String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.

        try {
            CdnDeliveryV3Response result = apiInstance.getDeliveryInfoV3(scenario, entityId, outputKind);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliveryV3Api#getDeliveryInfoV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DeliveryV3Api;

public class DeliveryV3ApiExample {
    public static void main(String[] args) {
        DeliveryV3Api apiInstance = new DeliveryV3Api();
        String scenario = scenario_example; // String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content
        String entityId = entityId_example; // String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
        String outputKind = outputKind_example; // String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.

        try {
            CdnDeliveryV3Response result = apiInstance.getDeliveryInfoV3(scenario, entityId, outputKind);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliveryV3Api#getDeliveryInfoV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DeliveryV3Api *apiInstance = [[DeliveryV3Api alloc] init];
String *scenario = scenario_example; // Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content (default to null)
String *entityId = entityId_example; // The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object. (default to null)
String *outputKind = outputKind_example; // Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+. (optional) (default to null)

// Get Delivery Info
[apiInstance getDeliveryInfoV3With:scenario
    entityId:entityId
    outputKind:outputKind
              completionHandler: ^(CdnDeliveryV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.DeliveryV3Api()
var scenario = scenario_example; // {String} Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content
var entityId = entityId_example; // {String} The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
var opts = {
  'outputKind': outputKind_example // {String} Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeliveryInfoV3(scenario, entityId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DeliveryV3Api();
            var scenario = scenario_example;  // String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content (default to null)
            var entityId = entityId_example;  // String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object. (default to null)
            var outputKind = outputKind_example;  // String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+. (optional)  (default to null)

            try {
                // Get Delivery Info
                CdnDeliveryV3Response result = apiInstance.getDeliveryInfoV3(scenario, entityId, outputKind);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DeliveryV3Api.getDeliveryInfoV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DeliveryV3Api();
$scenario = scenario_example; // String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content
$entityId = entityId_example; // String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
$outputKind = outputKind_example; // String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.

try {
    $result = $api_instance->getDeliveryInfoV3($scenario, $entityId, $outputKind);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeliveryV3Api->getDeliveryInfoV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DeliveryV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DeliveryV3Api->new();
my $scenario = scenario_example; # String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content
my $entityId = entityId_example; # String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
my $outputKind = outputKind_example; # String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.

eval {
    my $result = $api_instance->getDeliveryInfoV3(scenario => $scenario, entityId => $entityId, outputKind => $outputKind);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeliveryV3Api->getDeliveryInfoV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DeliveryV3Api()
scenario = scenario_example # String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content (default to null)
entityId = entityId_example # String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object. (default to null)
outputKind = outputKind_example # String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+. (optional) (default to null)

try:
    # Get Delivery Info
    api_response = api_instance.get_delivery_info_v3(scenario, entityId, outputKind=outputKind)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeliveryV3Api->getDeliveryInfoV3: %s\n" % e)
extern crate DeliveryV3Api;

pub fn main() {
    let scenario = scenario_example; // String
    let entityId = entityId_example; // String
    let outputKind = outputKind_example; // String

    let mut context = DeliveryV3Api::Context::default();
    let result = client.getDeliveryInfoV3(scenario, entityId, outputKind, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
scenario*
String
Used to determine the scenario in which to consume the media. - `onDemand` = stream a Video/Audio On Demand - `download` = Download the content for the user to play later. - `live` = Livestream the content
Required
entityId*
String
The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
Required
outputKind
String
Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


DiscordBotV2


getDiscordBotInfo

Info

TODO


/api/v2/discord/bot/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/discord/bot/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscordBotV2Api;

import java.io.File;
import java.util.*;

public class DiscordBotV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DiscordBotV2Api apiInstance = new DiscordBotV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getDiscordBotInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotV2Api#getDiscordBotInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DiscordBotV2Api;

public class DiscordBotV2ApiExample {
    public static void main(String[] args) {
        DiscordBotV2Api apiInstance = new DiscordBotV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getDiscordBotInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotV2Api#getDiscordBotInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DiscordBotV2Api *apiInstance = [[DiscordBotV2Api alloc] init];

// Info
[apiInstance getDiscordBotInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.DiscordBotV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDiscordBotInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscordBotV2Api();

            try {
                // Info
                oas_any_type_not_mapped result = apiInstance.getDiscordBotInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscordBotV2Api.getDiscordBotInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscordBotV2Api();

try {
    $result = $api_instance->getDiscordBotInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscordBotV2Api->getDiscordBotInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscordBotV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscordBotV2Api->new();

eval {
    my $result = $api_instance->getDiscordBotInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscordBotV2Api->getDiscordBotInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DiscordBotV2Api()

try:
    # Info
    api_response = api_instance.get_discord_bot_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscordBotV2Api->getDiscordBotInfo: %s\n" % e)
extern crate DiscordBotV2Api;

pub fn main() {

    let mut context = DiscordBotV2Api::Context::default();
    let result = client.getDiscordBotInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


joinDiscordServers

Join Discord Servers

TODO


/api/v2/discord/server/join

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/discord/server/join"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscordBotV2Api;

import java.io.File;
import java.util.*;

public class DiscordBotV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DiscordBotV2Api apiInstance = new DiscordBotV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.joinDiscordServers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotV2Api#joinDiscordServers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DiscordBotV2Api;

public class DiscordBotV2ApiExample {
    public static void main(String[] args) {
        DiscordBotV2Api apiInstance = new DiscordBotV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.joinDiscordServers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotV2Api#joinDiscordServers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DiscordBotV2Api *apiInstance = [[DiscordBotV2Api alloc] init];

// Join Discord Servers
[apiInstance joinDiscordServersWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.DiscordBotV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.joinDiscordServers(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscordBotV2Api();

            try {
                // Join Discord Servers
                oas_any_type_not_mapped result = apiInstance.joinDiscordServers();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscordBotV2Api.joinDiscordServers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscordBotV2Api();

try {
    $result = $api_instance->joinDiscordServers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscordBotV2Api->joinDiscordServers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscordBotV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscordBotV2Api->new();

eval {
    my $result = $api_instance->joinDiscordServers();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscordBotV2Api->joinDiscordServers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DiscordBotV2Api()

try:
    # Join Discord Servers
    api_response = api_instance.join_discord_servers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscordBotV2Api->joinDiscordServers: %s\n" % e)
extern crate DiscordBotV2Api;

pub fn main() {

    let mut context = DiscordBotV2Api::Context::default();
    let result = client.joinDiscordServers(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.



linkCallback

Link Callback

TODO


/api/v2/discord/bot/link/callback

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/discord/bot/link/callback"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscordBotV2Api;

import java.io.File;
import java.util.*;

public class DiscordBotV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DiscordBotV2Api apiInstance = new DiscordBotV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.linkCallback();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotV2Api#linkCallback");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DiscordBotV2Api;

public class DiscordBotV2ApiExample {
    public static void main(String[] args) {
        DiscordBotV2Api apiInstance = new DiscordBotV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.linkCallback();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotV2Api#linkCallback");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DiscordBotV2Api *apiInstance = [[DiscordBotV2Api alloc] init];

// Link Callback
[apiInstance linkCallbackWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.DiscordBotV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.linkCallback(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscordBotV2Api();

            try {
                // Link Callback
                oas_any_type_not_mapped result = apiInstance.linkCallback();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscordBotV2Api.linkCallback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscordBotV2Api();

try {
    $result = $api_instance->linkCallback();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscordBotV2Api->linkCallback: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscordBotV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscordBotV2Api->new();

eval {
    my $result = $api_instance->linkCallback();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscordBotV2Api->linkCallback: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DiscordBotV2Api()

try:
    # Link Callback
    api_response = api_instance.link_callback()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscordBotV2Api->linkCallback: %s\n" % e)
extern crate DiscordBotV2Api;

pub fn main() {

    let mut context = DiscordBotV2Api::Context::default();
    let result = client.linkCallback(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listDiscordBotConnections

List Connections

TODO


/api/v2/discord/bot/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/discord/bot/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscordBotV2Api;

import java.io.File;
import java.util.*;

public class DiscordBotV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DiscordBotV2Api apiInstance = new DiscordBotV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listDiscordBotConnections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotV2Api#listDiscordBotConnections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DiscordBotV2Api;

public class DiscordBotV2ApiExample {
    public static void main(String[] args) {
        DiscordBotV2Api apiInstance = new DiscordBotV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listDiscordBotConnections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotV2Api#listDiscordBotConnections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DiscordBotV2Api *apiInstance = [[DiscordBotV2Api alloc] init];

// List Connections
[apiInstance listDiscordBotConnectionsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.DiscordBotV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listDiscordBotConnections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscordBotV2Api();

            try {
                // List Connections
                oas_any_type_not_mapped result = apiInstance.listDiscordBotConnections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscordBotV2Api.listDiscordBotConnections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscordBotV2Api();

try {
    $result = $api_instance->listDiscordBotConnections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscordBotV2Api->listDiscordBotConnections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscordBotV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscordBotV2Api->new();

eval {
    my $result = $api_instance->listDiscordBotConnections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscordBotV2Api->listDiscordBotConnections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DiscordBotV2Api()

try:
    # List Connections
    api_response = api_instance.list_discord_bot_connections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscordBotV2Api->listDiscordBotConnections: %s\n" % e)
extern crate DiscordBotV2Api;

pub fn main() {

    let mut context = DiscordBotV2Api::Context::default();
    let result = client.listDiscordBotConnections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.




EdgesV2

getEdges

Get Edges

Retrieve a list of edge servers from which to stream or download videos. This is deprecated, and using the CDN endpoint is recommended as a replacement.


/api/v2/edges

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/edges"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EdgesV2Api;

import java.io.File;
import java.util.*;

public class EdgesV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EdgesV2Api apiInstance = new EdgesV2Api();

        try {
            EdgesModel result = apiInstance.getEdges();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EdgesV2Api#getEdges");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EdgesV2Api;

public class EdgesV2ApiExample {
    public static void main(String[] args) {
        EdgesV2Api apiInstance = new EdgesV2Api();

        try {
            EdgesModel result = apiInstance.getEdges();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EdgesV2Api#getEdges");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EdgesV2Api *apiInstance = [[EdgesV2Api alloc] init];

// Get Edges
[apiInstance getEdgesWithCompletionHandler: 
              ^(EdgesModel output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');

// Create an instance of the API class
var api = new FloatplaneRestApi.EdgesV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEdges(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getEdgesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new EdgesV2Api();

            try {
                // Get Edges
                EdgesModel result = apiInstance.getEdges();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EdgesV2Api.getEdges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EdgesV2Api();

try {
    $result = $api_instance->getEdges();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EdgesV2Api->getEdges: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EdgesV2Api;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EdgesV2Api->new();

eval {
    my $result = $api_instance->getEdges();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EdgesV2Api->getEdges: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EdgesV2Api()

try:
    # Get Edges
    api_response = api_instance.get_edges()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EdgesV2Api->getEdges: %s\n" % e)
extern crate EdgesV2Api;

pub fn main() {

    let mut context = EdgesV2Api::Context::default();
    let result = client.getEdges(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getVideoUrl

Get Video Url

TODO


/api/v2/video/url

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/url"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EdgesV2Api;

import java.io.File;
import java.util.*;

public class EdgesV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        EdgesV2Api apiInstance = new EdgesV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getVideoUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EdgesV2Api#getVideoUrl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EdgesV2Api;

public class EdgesV2ApiExample {
    public static void main(String[] args) {
        EdgesV2Api apiInstance = new EdgesV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getVideoUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EdgesV2Api#getVideoUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
EdgesV2Api *apiInstance = [[EdgesV2Api alloc] init];

// Get Video Url
[apiInstance getVideoUrlWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.EdgesV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoUrl(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new EdgesV2Api();

            try {
                // Get Video Url
                oas_any_type_not_mapped result = apiInstance.getVideoUrl();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EdgesV2Api.getVideoUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EdgesV2Api();

try {
    $result = $api_instance->getVideoUrl();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EdgesV2Api->getVideoUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EdgesV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EdgesV2Api->new();

eval {
    my $result = $api_instance->getVideoUrl();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EdgesV2Api->getVideoUrl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.EdgesV2Api()

try:
    # Get Video Url
    api_response = api_instance.get_video_url()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EdgesV2Api->getVideoUrl: %s\n" % e)
extern crate EdgesV2Api;

pub fn main() {

    let mut context = EdgesV2Api::Context::default();
    let result = client.getVideoUrl(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


FAQV2

getFaqSections

Get Faq Sections

Retrieve a list of FAQ sections to display to the user. Each section contains one or more FAQ items. This is normally accessible from https://www.floatplane.com/support. Note that the answers to the FAQs will contain HTML.


/api/v2/faq/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/faq/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FAQV2Api;

import java.io.File;
import java.util.*;

public class FAQV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FAQV2Api apiInstance = new FAQV2Api();

        try {
            array[FaqSectionModel] result = apiInstance.getFaqSections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FAQV2Api#getFaqSections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FAQV2Api;

public class FAQV2ApiExample {
    public static void main(String[] args) {
        FAQV2Api apiInstance = new FAQV2Api();

        try {
            array[FaqSectionModel] result = apiInstance.getFaqSections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FAQV2Api#getFaqSections");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FAQV2Api *apiInstance = [[FAQV2Api alloc] init];

// Get Faq Sections
[apiInstance getFaqSectionsWithCompletionHandler: 
              ^(array[FaqSectionModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');

// Create an instance of the API class
var api = new FloatplaneRestApi.FAQV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFaqSections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getFaqSectionsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new FAQV2Api();

            try {
                // Get Faq Sections
                array[FaqSectionModel] result = apiInstance.getFaqSections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FAQV2Api.getFaqSections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FAQV2Api();

try {
    $result = $api_instance->getFaqSections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FAQV2Api->getFaqSections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FAQV2Api;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FAQV2Api->new();

eval {
    my $result = $api_instance->getFaqSections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FAQV2Api->getFaqSections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FAQV2Api()

try:
    # Get Faq Sections
    api_response = api_instance.get_faq_sections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FAQV2Api->getFaqSections: %s\n" % e)
extern crate FAQV2Api;

pub fn main() {

    let mut context = FAQV2Api::Context::default();
    let result = client.getFaqSections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


IframeV2

getVideoPlayer

Get Video Player

TODO - Not used in Floatplane code.


/api/v2/get/player/{guid}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/get/player/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IframeV2Api;

import java.io.File;
import java.util.*;

public class IframeV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        IframeV2Api apiInstance = new IframeV2Api();
        String guid = guid_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.getVideoPlayer(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IframeV2Api#getVideoPlayer");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.IframeV2Api;

public class IframeV2ApiExample {
    public static void main(String[] args) {
        IframeV2Api apiInstance = new IframeV2Api();
        String guid = guid_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.getVideoPlayer(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IframeV2Api#getVideoPlayer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
IframeV2Api *apiInstance = [[IframeV2Api alloc] init];
String *guid = guid_example; //  (default to null)

// Get Video Player
[apiInstance getVideoPlayerWith:guid
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.IframeV2Api()
var guid = guid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoPlayer(guid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new IframeV2Api();
            var guid = guid_example;  // String |  (default to null)

            try {
                // Get Video Player
                oas_any_type_not_mapped result = apiInstance.getVideoPlayer(guid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling IframeV2Api.getVideoPlayer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IframeV2Api();
$guid = guid_example; // String | 

try {
    $result = $api_instance->getVideoPlayer($guid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IframeV2Api->getVideoPlayer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::IframeV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IframeV2Api->new();
my $guid = guid_example; # String | 

eval {
    my $result = $api_instance->getVideoPlayer(guid => $guid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IframeV2Api->getVideoPlayer: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.IframeV2Api()
guid = guid_example # String |  (default to null)

try:
    # Get Video Player
    api_response = api_instance.get_video_player(guid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IframeV2Api->getVideoPlayer: %s\n" % e)
extern crate IframeV2Api;

pub fn main() {
    let guid = guid_example; // String

    let mut context = IframeV2Api::Context::default();
    let result = client.getVideoPlayer(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ImageOptimizationsV2

getOptimizationsV3

Get Optimizations

TODO - Not used in Floatplane code.


/api/v2/image/optimizations/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/image/optimizations/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ImageOptimizationsV2Api;

import java.io.File;
import java.util.*;

public class ImageOptimizationsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ImageOptimizationsV2Api apiInstance = new ImageOptimizationsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getOptimizationsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageOptimizationsV2Api#getOptimizationsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ImageOptimizationsV2Api;

public class ImageOptimizationsV2ApiExample {
    public static void main(String[] args) {
        ImageOptimizationsV2Api apiInstance = new ImageOptimizationsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getOptimizationsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageOptimizationsV2Api#getOptimizationsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ImageOptimizationsV2Api *apiInstance = [[ImageOptimizationsV2Api alloc] init];

// Get Optimizations
[apiInstance getOptimizationsV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ImageOptimizationsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOptimizationsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ImageOptimizationsV2Api();

            try {
                // Get Optimizations
                oas_any_type_not_mapped result = apiInstance.getOptimizationsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ImageOptimizationsV2Api.getOptimizationsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ImageOptimizationsV2Api();

try {
    $result = $api_instance->getOptimizationsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImageOptimizationsV2Api->getOptimizationsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ImageOptimizationsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ImageOptimizationsV2Api->new();

eval {
    my $result = $api_instance->getOptimizationsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImageOptimizationsV2Api->getOptimizationsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ImageOptimizationsV2Api()

try:
    # Get Optimizations
    api_response = api_instance.get_optimizations_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImageOptimizationsV2Api->getOptimizationsV3: %s\n" % e)
extern crate ImageOptimizationsV2Api;

pub fn main() {

    let mut context = ImageOptimizationsV2Api::Context::default();
    let result = client.getOptimizationsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ImageOptimizationsV3

getOptimizationsV2

Get Optimizations

TODO


/api/v3/image/optimizations/

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/image/optimizations/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ImageOptimizationsV3Api;

import java.io.File;
import java.util.*;

public class ImageOptimizationsV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ImageOptimizationsV3Api apiInstance = new ImageOptimizationsV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getOptimizationsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageOptimizationsV3Api#getOptimizationsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ImageOptimizationsV3Api;

public class ImageOptimizationsV3ApiExample {
    public static void main(String[] args) {
        ImageOptimizationsV3Api apiInstance = new ImageOptimizationsV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getOptimizationsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageOptimizationsV3Api#getOptimizationsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ImageOptimizationsV3Api *apiInstance = [[ImageOptimizationsV3Api alloc] init];

// Get Optimizations
[apiInstance getOptimizationsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ImageOptimizationsV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOptimizationsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ImageOptimizationsV3Api();

            try {
                // Get Optimizations
                oas_any_type_not_mapped result = apiInstance.getOptimizationsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ImageOptimizationsV3Api.getOptimizationsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ImageOptimizationsV3Api();

try {
    $result = $api_instance->getOptimizationsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImageOptimizationsV3Api->getOptimizationsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ImageOptimizationsV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ImageOptimizationsV3Api->new();

eval {
    my $result = $api_instance->getOptimizationsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImageOptimizationsV3Api->getOptimizationsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ImageOptimizationsV3Api()

try:
    # Get Optimizations
    api_response = api_instance.get_optimizations_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImageOptimizationsV3Api->getOptimizationsV2: %s\n" % e)
extern crate ImageOptimizationsV3Api;

pub fn main() {

    let mut context = ImageOptimizationsV3Api::Context::default();
    let result = client.getOptimizationsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


LivestreamV2

renderLivePopout

Render Live Popout

TODO


/v2/live/popout

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/v2/live/popout"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LivestreamV2Api;

import java.io.File;
import java.util.*;

public class LivestreamV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        LivestreamV2Api apiInstance = new LivestreamV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.renderLivePopout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamV2Api#renderLivePopout");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LivestreamV2Api;

public class LivestreamV2ApiExample {
    public static void main(String[] args) {
        LivestreamV2Api apiInstance = new LivestreamV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.renderLivePopout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamV2Api#renderLivePopout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
LivestreamV2Api *apiInstance = [[LivestreamV2Api alloc] init];

// Render Live Popout
[apiInstance renderLivePopoutWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.LivestreamV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.renderLivePopout(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new LivestreamV2Api();

            try {
                // Render Live Popout
                oas_any_type_not_mapped result = apiInstance.renderLivePopout();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LivestreamV2Api.renderLivePopout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LivestreamV2Api();

try {
    $result = $api_instance->renderLivePopout();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LivestreamV2Api->renderLivePopout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LivestreamV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LivestreamV2Api->new();

eval {
    my $result = $api_instance->renderLivePopout();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LivestreamV2Api->renderLivePopout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.LivestreamV2Api()

try:
    # Render Live Popout
    api_response = api_instance.render_live_popout()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LivestreamV2Api->renderLivePopout: %s\n" % e)
extern crate LivestreamV2Api;

pub fn main() {

    let mut context = LivestreamV2Api::Context::default();
    let result = client.renderLivePopout(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateConfig

Update Config

TODO


/api/v2/live/config/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/live/config/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LivestreamV2Api;

import java.io.File;
import java.util.*;

public class LivestreamV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        LivestreamV2Api apiInstance = new LivestreamV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateConfig();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamV2Api#updateConfig");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LivestreamV2Api;

public class LivestreamV2ApiExample {
    public static void main(String[] args) {
        LivestreamV2Api apiInstance = new LivestreamV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateConfig();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamV2Api#updateConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
LivestreamV2Api *apiInstance = [[LivestreamV2Api alloc] init];

// Update Config
[apiInstance updateConfigWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.LivestreamV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateConfig(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new LivestreamV2Api();

            try {
                // Update Config
                oas_any_type_not_mapped result = apiInstance.updateConfig();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LivestreamV2Api.updateConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LivestreamV2Api();

try {
    $result = $api_instance->updateConfig();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LivestreamV2Api->updateConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LivestreamV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LivestreamV2Api->new();

eval {
    my $result = $api_instance->updateConfig();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LivestreamV2Api->updateConfig: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.LivestreamV2Api()

try:
    # Update Config
    api_response = api_instance.update_config()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LivestreamV2Api->updateConfig: %s\n" % e)
extern crate LivestreamV2Api;

pub fn main() {

    let mut context = LivestreamV2Api::Context::default();
    let result = client.updateConfig(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


uploadLiveThumbnail

Upload Thumbnail

TODO


/api/v2/live/thumbnail/upload

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/live/thumbnail/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LivestreamV2Api;

import java.io.File;
import java.util.*;

public class LivestreamV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        LivestreamV2Api apiInstance = new LivestreamV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadLiveThumbnail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamV2Api#uploadLiveThumbnail");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LivestreamV2Api;

public class LivestreamV2ApiExample {
    public static void main(String[] args) {
        LivestreamV2Api apiInstance = new LivestreamV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadLiveThumbnail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamV2Api#uploadLiveThumbnail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
LivestreamV2Api *apiInstance = [[LivestreamV2Api alloc] init];

// Upload Thumbnail
[apiInstance uploadLiveThumbnailWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.LivestreamV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadLiveThumbnail(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new LivestreamV2Api();

            try {
                // Upload Thumbnail
                oas_any_type_not_mapped result = apiInstance.uploadLiveThumbnail();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LivestreamV2Api.uploadLiveThumbnail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LivestreamV2Api();

try {
    $result = $api_instance->uploadLiveThumbnail();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LivestreamV2Api->uploadLiveThumbnail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LivestreamV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LivestreamV2Api->new();

eval {
    my $result = $api_instance->uploadLiveThumbnail();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LivestreamV2Api->uploadLiveThumbnail: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.LivestreamV2Api()

try:
    # Upload Thumbnail
    api_response = api_instance.upload_live_thumbnail()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LivestreamV2Api->uploadLiveThumbnail: %s\n" % e)
extern crate LivestreamV2Api;

pub fn main() {

    let mut context = LivestreamV2Api::Context::default();
    let result = client.uploadLiveThumbnail(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


LoyaltyRewardsV3

claimLoyaltyReward

Claim Loyalty Reward

TODO


/api/v3/user/loyaltyreward/claim

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/loyaltyreward/claim"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LoyaltyRewardsV3Api;

import java.io.File;
import java.util.*;

public class LoyaltyRewardsV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        LoyaltyRewardsV3Api apiInstance = new LoyaltyRewardsV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.claimLoyaltyReward();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoyaltyRewardsV3Api#claimLoyaltyReward");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LoyaltyRewardsV3Api;

public class LoyaltyRewardsV3ApiExample {
    public static void main(String[] args) {
        LoyaltyRewardsV3Api apiInstance = new LoyaltyRewardsV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.claimLoyaltyReward();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoyaltyRewardsV3Api#claimLoyaltyReward");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
LoyaltyRewardsV3Api *apiInstance = [[LoyaltyRewardsV3Api alloc] init];

// Claim Loyalty Reward
[apiInstance claimLoyaltyRewardWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.LoyaltyRewardsV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.claimLoyaltyReward(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new LoyaltyRewardsV3Api();

            try {
                // Claim Loyalty Reward
                oas_any_type_not_mapped result = apiInstance.claimLoyaltyReward();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LoyaltyRewardsV3Api.claimLoyaltyReward: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LoyaltyRewardsV3Api();

try {
    $result = $api_instance->claimLoyaltyReward();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyRewardsV3Api->claimLoyaltyReward: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LoyaltyRewardsV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LoyaltyRewardsV3Api->new();

eval {
    my $result = $api_instance->claimLoyaltyReward();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoyaltyRewardsV3Api->claimLoyaltyReward: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.LoyaltyRewardsV3Api()

try:
    # Claim Loyalty Reward
    api_response = api_instance.claim_loyalty_reward()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoyaltyRewardsV3Api->claimLoyaltyReward: %s\n" % e)
extern crate LoyaltyRewardsV3Api;

pub fn main() {

    let mut context = LoyaltyRewardsV3Api::Context::default();
    let result = client.claimLoyaltyReward(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listCreatorLoyaltyReward

List Creator Loyalty Reward

Retrieve a list of loyalty rewards for the user. The reason for why this is a POST and not a GET is unknown.


/api/v3/user/loyaltyreward/list

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/loyaltyreward/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LoyaltyRewardsV3Api;

import java.io.File;
import java.util.*;

public class LoyaltyRewardsV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        LoyaltyRewardsV3Api apiInstance = new LoyaltyRewardsV3Api();

        try {
            array[Object] result = apiInstance.listCreatorLoyaltyReward();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoyaltyRewardsV3Api#listCreatorLoyaltyReward");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LoyaltyRewardsV3Api;

public class LoyaltyRewardsV3ApiExample {
    public static void main(String[] args) {
        LoyaltyRewardsV3Api apiInstance = new LoyaltyRewardsV3Api();

        try {
            array[Object] result = apiInstance.listCreatorLoyaltyReward();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoyaltyRewardsV3Api#listCreatorLoyaltyReward");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
LoyaltyRewardsV3Api *apiInstance = [[LoyaltyRewardsV3Api alloc] init];

// List Creator Loyalty Reward
[apiInstance listCreatorLoyaltyRewardWithCompletionHandler: 
              ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.LoyaltyRewardsV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorLoyaltyReward(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new LoyaltyRewardsV3Api();

            try {
                // List Creator Loyalty Reward
                array[Object] result = apiInstance.listCreatorLoyaltyReward();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LoyaltyRewardsV3Api.listCreatorLoyaltyReward: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LoyaltyRewardsV3Api();

try {
    $result = $api_instance->listCreatorLoyaltyReward();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyRewardsV3Api->listCreatorLoyaltyReward: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LoyaltyRewardsV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LoyaltyRewardsV3Api->new();

eval {
    my $result = $api_instance->listCreatorLoyaltyReward();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoyaltyRewardsV3Api->listCreatorLoyaltyReward: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.LoyaltyRewardsV3Api()

try:
    # List Creator Loyalty Reward
    api_response = api_instance.list_creator_loyalty_reward()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoyaltyRewardsV3Api->listCreatorLoyaltyReward: %s\n" % e)
extern crate LoyaltyRewardsV3Api;

pub fn main() {

    let mut context = LoyaltyRewardsV3Api::Context::default();
    let result = client.listCreatorLoyaltyReward(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


MediaV2

deleteVideo

Delete Video

TODO - Not used in Floatplane code.


/api/v2/video/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaV2Api;

import java.io.File;
import java.util.*;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#deleteVideo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaV2Api;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#deleteVideo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
MediaV2Api *apiInstance = [[MediaV2Api alloc] init];

// Delete Video
[apiInstance deleteVideoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.MediaV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteVideo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new MediaV2Api();

            try {
                // Delete Video
                oas_any_type_not_mapped result = apiInstance.deleteVideo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaV2Api.deleteVideo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaV2Api();

try {
    $result = $api_instance->deleteVideo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaV2Api->deleteVideo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaV2Api->new();

eval {
    my $result = $api_instance->deleteVideo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaV2Api->deleteVideo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaV2Api()

try:
    # Delete Video
    api_response = api_instance.delete_video()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaV2Api->deleteVideo: %s\n" % e)
extern crate MediaV2Api;

pub fn main() {

    let mut context = MediaV2Api::Context::default();
    let result = client.deleteVideo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getList

Get List

TODO - Not used in Floatplane code.


/api/v2/video/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaV2Api;

import java.io.File;
import java.util.*;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#getList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaV2Api;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#getList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
MediaV2Api *apiInstance = [[MediaV2Api alloc] init];

// Get List
[apiInstance getListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.MediaV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new MediaV2Api();

            try {
                // Get List
                oas_any_type_not_mapped result = apiInstance.getList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaV2Api.getList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaV2Api();

try {
    $result = $api_instance->getList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaV2Api->getList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaV2Api->new();

eval {
    my $result = $api_instance->getList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaV2Api->getList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaV2Api()

try:
    # Get List
    api_response = api_instance.get_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaV2Api->getList: %s\n" % e)
extern crate MediaV2Api;

pub fn main() {

    let mut context = MediaV2Api::Context::default();
    let result = client.getList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getRelatedVideos

Get Related Videos

TODO - Not used in Floatplane code.


/api/v2/video/related

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/related"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaV2Api;

import java.io.File;
import java.util.*;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getRelatedVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#getRelatedVideos");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaV2Api;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getRelatedVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#getRelatedVideos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
MediaV2Api *apiInstance = [[MediaV2Api alloc] init];

// Get Related Videos
[apiInstance getRelatedVideosWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.MediaV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRelatedVideos(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new MediaV2Api();

            try {
                // Get Related Videos
                oas_any_type_not_mapped result = apiInstance.getRelatedVideos();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaV2Api.getRelatedVideos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaV2Api();

try {
    $result = $api_instance->getRelatedVideos();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaV2Api->getRelatedVideos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaV2Api->new();

eval {
    my $result = $api_instance->getRelatedVideos();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaV2Api->getRelatedVideos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaV2Api()

try:
    # Get Related Videos
    api_response = api_instance.get_related_videos()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaV2Api->getRelatedVideos: %s\n" % e)
extern crate MediaV2Api;

pub fn main() {

    let mut context = MediaV2Api::Context::default();
    let result = client.getRelatedVideos(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getVideo

Get Video

TODO - Not used in Floatplane code.


/api/v2/video/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaV2Api;

import java.io.File;
import java.util.*;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#getVideo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaV2Api;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#getVideo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
MediaV2Api *apiInstance = [[MediaV2Api alloc] init];

// Get Video
[apiInstance getVideoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.MediaV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new MediaV2Api();

            try {
                // Get Video
                oas_any_type_not_mapped result = apiInstance.getVideo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaV2Api.getVideo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaV2Api();

try {
    $result = $api_instance->getVideo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaV2Api->getVideo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaV2Api->new();

eval {
    my $result = $api_instance->getVideo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaV2Api->getVideo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaV2Api()

try:
    # Get Video
    api_response = api_instance.get_video()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaV2Api->getVideo: %s\n" % e)
extern crate MediaV2Api;

pub fn main() {

    let mut context = MediaV2Api::Context::default();
    let result = client.getVideo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateVideo

Update Video

TODO - Not used in Floatplane code.


/api/v2/video/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaV2Api;

import java.io.File;
import java.util.*;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#updateVideo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaV2Api;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#updateVideo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
MediaV2Api *apiInstance = [[MediaV2Api alloc] init];

// Update Video
[apiInstance updateVideoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.MediaV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateVideo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new MediaV2Api();

            try {
                // Update Video
                oas_any_type_not_mapped result = apiInstance.updateVideo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaV2Api.updateVideo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaV2Api();

try {
    $result = $api_instance->updateVideo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaV2Api->updateVideo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaV2Api->new();

eval {
    my $result = $api_instance->updateVideo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaV2Api->updateVideo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaV2Api()

try:
    # Update Video
    api_response = api_instance.update_video()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaV2Api->updateVideo: %s\n" % e)
extern crate MediaV2Api;

pub fn main() {

    let mut context = MediaV2Api::Context::default();
    let result = client.updateVideo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


watchKey

Watch Key

TODO. This seems to originate from the `.m3u8` file captured from the CDN endpoint, and is not usually called directly from code.


/api/v2/video/watchkey

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/watchkey"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaV2Api;

import java.io.File;
import java.util.*;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.watchKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#watchKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaV2Api;

public class MediaV2ApiExample {
    public static void main(String[] args) {
        MediaV2Api apiInstance = new MediaV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.watchKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaV2Api#watchKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
MediaV2Api *apiInstance = [[MediaV2Api alloc] init];

// Watch Key
[apiInstance watchKeyWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.MediaV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.watchKey(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new MediaV2Api();

            try {
                // Watch Key
                oas_any_type_not_mapped result = apiInstance.watchKey();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaV2Api.watchKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaV2Api();

try {
    $result = $api_instance->watchKey();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaV2Api->watchKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaV2Api->new();

eval {
    my $result = $api_instance->watchKey();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaV2Api->watchKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaV2Api()

try:
    # Watch Key
    api_response = api_instance.watch_key()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaV2Api->watchKey: %s\n" % e)
extern crate MediaV2Api;

pub fn main() {

    let mut context = MediaV2Api::Context::default();
    let result = client.watchKey(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ModerationV2

banUserV2

Ban User

TODO - Not used in Floatplane code.


/api/v2/moderation/user/ban

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/moderation/user/ban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV2Api;

import java.io.File;
import java.util.*;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.banUserV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#banUserV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV2Api;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.banUserV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#banUserV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV2Api *apiInstance = [[ModerationV2Api alloc] init];

// Ban User
[apiInstance banUserV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.banUserV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV2Api();

            try {
                // Ban User
                oas_any_type_not_mapped result = apiInstance.banUserV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV2Api.banUserV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV2Api();

try {
    $result = $api_instance->banUserV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV2Api->banUserV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV2Api->new();

eval {
    my $result = $api_instance->banUserV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV2Api->banUserV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV2Api()

try:
    # Ban User
    api_response = api_instance.ban_user_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV2Api->banUserV2: %s\n" % e)
extern crate ModerationV2Api;

pub fn main() {

    let mut context = ModerationV2Api::Context::default();
    let result = client.banUserV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


hideCommentV2

Hide Comment

TODO - Not used in Floatplane code.


/api/v2/moderation/comment/hide

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/moderation/comment/hide"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV2Api;

import java.io.File;
import java.util.*;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.hideCommentV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#hideCommentV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV2Api;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.hideCommentV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#hideCommentV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV2Api *apiInstance = [[ModerationV2Api alloc] init];

// Hide Comment
[apiInstance hideCommentV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.hideCommentV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV2Api();

            try {
                // Hide Comment
                oas_any_type_not_mapped result = apiInstance.hideCommentV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV2Api.hideCommentV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV2Api();

try {
    $result = $api_instance->hideCommentV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV2Api->hideCommentV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV2Api->new();

eval {
    my $result = $api_instance->hideCommentV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV2Api->hideCommentV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV2Api()

try:
    # Hide Comment
    api_response = api_instance.hide_comment_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV2Api->hideCommentV2: %s\n" % e)
extern crate ModerationV2Api;

pub fn main() {

    let mut context = ModerationV2Api::Context::default();
    let result = client.hideCommentV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listBanV2

List Ban

TODO - Not used in Floatplane code.


/api/v2/moderation/user/ban/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/moderation/user/ban/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV2Api;

import java.io.File;
import java.util.*;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listBanV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#listBanV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV2Api;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listBanV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#listBanV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV2Api *apiInstance = [[ModerationV2Api alloc] init];

// List Ban
[apiInstance listBanV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listBanV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV2Api();

            try {
                // List Ban
                oas_any_type_not_mapped result = apiInstance.listBanV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV2Api.listBanV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV2Api();

try {
    $result = $api_instance->listBanV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV2Api->listBanV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV2Api->new();

eval {
    my $result = $api_instance->listBanV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV2Api->listBanV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV2Api()

try:
    # List Ban
    api_response = api_instance.list_ban_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV2Api->listBanV2: %s\n" % e)
extern crate ModerationV2Api;

pub fn main() {

    let mut context = ModerationV2Api::Context::default();
    let result = client.listBanV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


moderateVideoComment

Moderate Video Comment

TODO - Not used in Floatplane code.


/api/v2/comment/moderate/

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/comment/moderate/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV2Api;

import java.io.File;
import java.util.*;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.moderateVideoComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#moderateVideoComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV2Api;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.moderateVideoComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#moderateVideoComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV2Api *apiInstance = [[ModerationV2Api alloc] init];

// Moderate Video Comment
[apiInstance moderateVideoCommentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moderateVideoComment(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV2Api();

            try {
                // Moderate Video Comment
                oas_any_type_not_mapped result = apiInstance.moderateVideoComment();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV2Api.moderateVideoComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV2Api();

try {
    $result = $api_instance->moderateVideoComment();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV2Api->moderateVideoComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV2Api->new();

eval {
    my $result = $api_instance->moderateVideoComment();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV2Api->moderateVideoComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV2Api()

try:
    # Moderate Video Comment
    api_response = api_instance.moderate_video_comment()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV2Api->moderateVideoComment: %s\n" % e)
extern crate ModerationV2Api;

pub fn main() {

    let mut context = ModerationV2Api::Context::default();
    let result = client.moderateVideoComment(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


unbanUserV2

Unban User

TODO - Not used in Floatplane code.


/api/v2/moderation/user/unban

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/moderation/user/unban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV2Api;

import java.io.File;
import java.util.*;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unbanUserV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#unbanUserV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV2Api;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unbanUserV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#unbanUserV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV2Api *apiInstance = [[ModerationV2Api alloc] init];

// Unban User
[apiInstance unbanUserV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unbanUserV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV2Api();

            try {
                // Unban User
                oas_any_type_not_mapped result = apiInstance.unbanUserV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV2Api.unbanUserV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV2Api();

try {
    $result = $api_instance->unbanUserV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV2Api->unbanUserV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV2Api->new();

eval {
    my $result = $api_instance->unbanUserV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV2Api->unbanUserV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV2Api()

try:
    # Unban User
    api_response = api_instance.unban_user_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV2Api->unbanUserV2: %s\n" % e)
extern crate ModerationV2Api;

pub fn main() {

    let mut context = ModerationV2Api::Context::default();
    let result = client.unbanUserV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


unhideCommentV2

Unhide Comment

TODO - Not used in Floatplane code.


/api/v2/moderation/comment/unhide

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/moderation/comment/unhide"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV2Api;

import java.io.File;
import java.util.*;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unhideCommentV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#unhideCommentV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV2Api;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unhideCommentV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#unhideCommentV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV2Api *apiInstance = [[ModerationV2Api alloc] init];

// Unhide Comment
[apiInstance unhideCommentV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unhideCommentV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV2Api();

            try {
                // Unhide Comment
                oas_any_type_not_mapped result = apiInstance.unhideCommentV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV2Api.unhideCommentV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV2Api();

try {
    $result = $api_instance->unhideCommentV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV2Api->unhideCommentV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV2Api->new();

eval {
    my $result = $api_instance->unhideCommentV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV2Api->unhideCommentV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV2Api()

try:
    # Unhide Comment
    api_response = api_instance.unhide_comment_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV2Api->unhideCommentV2: %s\n" % e)
extern crate ModerationV2Api;

pub fn main() {

    let mut context = ModerationV2Api::Context::default();
    let result = client.unhideCommentV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


userBanStatusV2

User Ban Status

TODO - Not used in Floatplane code.


/api/v2/moderator/userBanStatus

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/moderator/userBanStatus"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV2Api;

import java.io.File;
import java.util.*;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userBanStatusV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#userBanStatusV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV2Api;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userBanStatusV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#userBanStatusV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV2Api *apiInstance = [[ModerationV2Api alloc] init];

// User Ban Status
[apiInstance userBanStatusV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userBanStatusV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV2Api();

            try {
                // User Ban Status
                oas_any_type_not_mapped result = apiInstance.userBanStatusV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV2Api.userBanStatusV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV2Api();

try {
    $result = $api_instance->userBanStatusV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV2Api->userBanStatusV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV2Api->new();

eval {
    my $result = $api_instance->userBanStatusV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV2Api->userBanStatusV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV2Api()

try:
    # User Ban Status
    api_response = api_instance.user_ban_status_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV2Api->userBanStatusV2: %s\n" % e)
extern crate ModerationV2Api;

pub fn main() {

    let mut context = ModerationV2Api::Context::default();
    let result = client.userBanStatusV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


userInfoV2

User Info

TODO - Not used in Floatplane code.


/api/v2/moderation/user/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/moderation/user/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV2Api;

import java.io.File;
import java.util.*;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userInfoV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#userInfoV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV2Api;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userInfoV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#userInfoV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV2Api *apiInstance = [[ModerationV2Api alloc] init];

// User Info
[apiInstance userInfoV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userInfoV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV2Api();

            try {
                // User Info
                oas_any_type_not_mapped result = apiInstance.userInfoV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV2Api.userInfoV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV2Api();

try {
    $result = $api_instance->userInfoV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV2Api->userInfoV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV2Api->new();

eval {
    my $result = $api_instance->userInfoV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV2Api->userInfoV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV2Api()

try:
    # User Info
    api_response = api_instance.user_info_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV2Api->userInfoV2: %s\n" % e)
extern crate ModerationV2Api;

pub fn main() {

    let mut context = ModerationV2Api::Context::default();
    let result = client.userInfoV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


userUnbanV2

User Unban

TODO - Not used in Floatplane code.


/api/v2/moderator/user/unban

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/moderator/user/unban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV2Api;

import java.io.File;
import java.util.*;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userUnbanV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#userUnbanV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV2Api;

public class ModerationV2ApiExample {
    public static void main(String[] args) {
        ModerationV2Api apiInstance = new ModerationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userUnbanV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV2Api#userUnbanV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV2Api *apiInstance = [[ModerationV2Api alloc] init];

// User Unban
[apiInstance userUnbanV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userUnbanV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV2Api();

            try {
                // User Unban
                oas_any_type_not_mapped result = apiInstance.userUnbanV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV2Api.userUnbanV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV2Api();

try {
    $result = $api_instance->userUnbanV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV2Api->userUnbanV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV2Api->new();

eval {
    my $result = $api_instance->userUnbanV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV2Api->userUnbanV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV2Api()

try:
    # User Unban
    api_response = api_instance.user_unban_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV2Api->userUnbanV2: %s\n" % e)
extern crate ModerationV2Api;

pub fn main() {

    let mut context = ModerationV2Api::Context::default();
    let result = client.userUnbanV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ModerationV3

banUserV3

Ban User

TODO


/api/v3/moderation/user/ban

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/moderation/user/ban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV3Api;

import java.io.File;
import java.util.*;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.banUserV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#banUserV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV3Api;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.banUserV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#banUserV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV3Api *apiInstance = [[ModerationV3Api alloc] init];

// Ban User
[apiInstance banUserV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.banUserV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV3Api();

            try {
                // Ban User
                oas_any_type_not_mapped result = apiInstance.banUserV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV3Api.banUserV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV3Api();

try {
    $result = $api_instance->banUserV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV3Api->banUserV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV3Api->new();

eval {
    my $result = $api_instance->banUserV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV3Api->banUserV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV3Api()

try:
    # Ban User
    api_response = api_instance.ban_user_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV3Api->banUserV3: %s\n" % e)
extern crate ModerationV3Api;

pub fn main() {

    let mut context = ModerationV3Api::Context::default();
    let result = client.banUserV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


hideCommentV3

Hide Comment

TODO


/api/v3/moderation/comment/hide

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/moderation/comment/hide"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV3Api;

import java.io.File;
import java.util.*;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.hideCommentV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#hideCommentV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV3Api;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.hideCommentV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#hideCommentV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV3Api *apiInstance = [[ModerationV3Api alloc] init];

// Hide Comment
[apiInstance hideCommentV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.hideCommentV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV3Api();

            try {
                // Hide Comment
                oas_any_type_not_mapped result = apiInstance.hideCommentV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV3Api.hideCommentV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV3Api();

try {
    $result = $api_instance->hideCommentV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV3Api->hideCommentV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV3Api->new();

eval {
    my $result = $api_instance->hideCommentV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV3Api->hideCommentV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV3Api()

try:
    # Hide Comment
    api_response = api_instance.hide_comment_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV3Api->hideCommentV3: %s\n" % e)
extern crate ModerationV3Api;

pub fn main() {

    let mut context = ModerationV3Api::Context::default();
    let result = client.hideCommentV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listBanV3

List Ban

TODO


/api/v3/moderation/user/ban/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/moderation/user/ban/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV3Api;

import java.io.File;
import java.util.*;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listBanV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#listBanV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV3Api;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listBanV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#listBanV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV3Api *apiInstance = [[ModerationV3Api alloc] init];

// List Ban
[apiInstance listBanV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listBanV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV3Api();

            try {
                // List Ban
                oas_any_type_not_mapped result = apiInstance.listBanV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV3Api.listBanV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV3Api();

try {
    $result = $api_instance->listBanV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV3Api->listBanV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV3Api->new();

eval {
    my $result = $api_instance->listBanV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV3Api->listBanV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV3Api()

try:
    # List Ban
    api_response = api_instance.list_ban_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV3Api->listBanV3: %s\n" % e)
extern crate ModerationV3Api;

pub fn main() {

    let mut context = ModerationV3Api::Context::default();
    let result = client.listBanV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


moderateComment

Moderate Comment

TODO


/api/v3/comment/moderate/

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/comment/moderate/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV3Api;

import java.io.File;
import java.util.*;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.moderateComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#moderateComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV3Api;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.moderateComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#moderateComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV3Api *apiInstance = [[ModerationV3Api alloc] init];

// Moderate Comment
[apiInstance moderateCommentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moderateComment(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV3Api();

            try {
                // Moderate Comment
                oas_any_type_not_mapped result = apiInstance.moderateComment();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV3Api.moderateComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV3Api();

try {
    $result = $api_instance->moderateComment();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV3Api->moderateComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV3Api->new();

eval {
    my $result = $api_instance->moderateComment();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV3Api->moderateComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV3Api()

try:
    # Moderate Comment
    api_response = api_instance.moderate_comment()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV3Api->moderateComment: %s\n" % e)
extern crate ModerationV3Api;

pub fn main() {

    let mut context = ModerationV3Api::Context::default();
    let result = client.moderateComment(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


unbanUserV3

Unban User

TODO


/api/v3/moderation/user/unban

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/moderation/user/unban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV3Api;

import java.io.File;
import java.util.*;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unbanUserV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#unbanUserV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV3Api;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unbanUserV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#unbanUserV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV3Api *apiInstance = [[ModerationV3Api alloc] init];

// Unban User
[apiInstance unbanUserV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unbanUserV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV3Api();

            try {
                // Unban User
                oas_any_type_not_mapped result = apiInstance.unbanUserV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV3Api.unbanUserV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV3Api();

try {
    $result = $api_instance->unbanUserV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV3Api->unbanUserV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV3Api->new();

eval {
    my $result = $api_instance->unbanUserV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV3Api->unbanUserV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV3Api()

try:
    # Unban User
    api_response = api_instance.unban_user_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV3Api->unbanUserV3: %s\n" % e)
extern crate ModerationV3Api;

pub fn main() {

    let mut context = ModerationV3Api::Context::default();
    let result = client.unbanUserV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


unhideCommentV3

Unhide Comment

TODO


/api/v3/moderation/comment/unhide

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/moderation/comment/unhide"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV3Api;

import java.io.File;
import java.util.*;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unhideCommentV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#unhideCommentV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV3Api;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unhideCommentV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#unhideCommentV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV3Api *apiInstance = [[ModerationV3Api alloc] init];

// Unhide Comment
[apiInstance unhideCommentV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unhideCommentV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV3Api();

            try {
                // Unhide Comment
                oas_any_type_not_mapped result = apiInstance.unhideCommentV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV3Api.unhideCommentV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV3Api();

try {
    $result = $api_instance->unhideCommentV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV3Api->unhideCommentV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV3Api->new();

eval {
    my $result = $api_instance->unhideCommentV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV3Api->unhideCommentV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV3Api()

try:
    # Unhide Comment
    api_response = api_instance.unhide_comment_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV3Api->unhideCommentV3: %s\n" % e)
extern crate ModerationV3Api;

pub fn main() {

    let mut context = ModerationV3Api::Context::default();
    let result = client.unhideCommentV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


userBanStatusV3

User Ban Status

TODO


/api/v3/moderator/userBanStatus

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/moderator/userBanStatus"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV3Api;

import java.io.File;
import java.util.*;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userBanStatusV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#userBanStatusV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV3Api;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userBanStatusV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#userBanStatusV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV3Api *apiInstance = [[ModerationV3Api alloc] init];

// User Ban Status
[apiInstance userBanStatusV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userBanStatusV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV3Api();

            try {
                // User Ban Status
                oas_any_type_not_mapped result = apiInstance.userBanStatusV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV3Api.userBanStatusV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV3Api();

try {
    $result = $api_instance->userBanStatusV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV3Api->userBanStatusV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV3Api->new();

eval {
    my $result = $api_instance->userBanStatusV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV3Api->userBanStatusV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV3Api()

try:
    # User Ban Status
    api_response = api_instance.user_ban_status_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV3Api->userBanStatusV3: %s\n" % e)
extern crate ModerationV3Api;

pub fn main() {

    let mut context = ModerationV3Api::Context::default();
    let result = client.userBanStatusV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


userInfoV3

User Info

TODO


/api/v3/moderation/user/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/moderation/user/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV3Api;

import java.io.File;
import java.util.*;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userInfoV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#userInfoV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV3Api;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userInfoV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#userInfoV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV3Api *apiInstance = [[ModerationV3Api alloc] init];

// User Info
[apiInstance userInfoV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userInfoV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV3Api();

            try {
                // User Info
                oas_any_type_not_mapped result = apiInstance.userInfoV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV3Api.userInfoV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV3Api();

try {
    $result = $api_instance->userInfoV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV3Api->userInfoV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV3Api->new();

eval {
    my $result = $api_instance->userInfoV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV3Api->userInfoV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV3Api()

try:
    # User Info
    api_response = api_instance.user_info_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV3Api->userInfoV3: %s\n" % e)
extern crate ModerationV3Api;

pub fn main() {

    let mut context = ModerationV3Api::Context::default();
    let result = client.userInfoV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


userUnbanV3

User Unban

TODO


/api/v3/moderator/user/unban

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/moderator/user/unban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationV3Api;

import java.io.File;
import java.util.*;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userUnbanV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#userUnbanV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationV3Api;

public class ModerationV3ApiExample {
    public static void main(String[] args) {
        ModerationV3Api apiInstance = new ModerationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.userUnbanV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationV3Api#userUnbanV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ModerationV3Api *apiInstance = [[ModerationV3Api alloc] init];

// User Unban
[apiInstance userUnbanV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ModerationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userUnbanV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ModerationV3Api();

            try {
                // User Unban
                oas_any_type_not_mapped result = apiInstance.userUnbanV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationV3Api.userUnbanV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationV3Api();

try {
    $result = $api_instance->userUnbanV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationV3Api->userUnbanV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationV3Api->new();

eval {
    my $result = $api_instance->userUnbanV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationV3Api->userUnbanV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationV3Api()

try:
    # User Unban
    api_response = api_instance.user_unban_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationV3Api->userUnbanV3: %s\n" % e)
extern crate ModerationV3Api;

pub fn main() {

    let mut context = ModerationV3Api::Context::default();
    let result = client.userUnbanV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


PasswordResetV2

resetPassword

Reset Password

TODO


/api/v2/user/password/reset

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/password/reset"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordResetV2Api;

import java.io.File;
import java.util.*;

public class PasswordResetV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PasswordResetV2Api apiInstance = new PasswordResetV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.resetPassword();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetV2Api#resetPassword");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PasswordResetV2Api;

public class PasswordResetV2ApiExample {
    public static void main(String[] args) {
        PasswordResetV2Api apiInstance = new PasswordResetV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.resetPassword();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetV2Api#resetPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PasswordResetV2Api *apiInstance = [[PasswordResetV2Api alloc] init];

// Reset Password
[apiInstance resetPasswordWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PasswordResetV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.resetPassword(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PasswordResetV2Api();

            try {
                // Reset Password
                oas_any_type_not_mapped result = apiInstance.resetPassword();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordResetV2Api.resetPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordResetV2Api();

try {
    $result = $api_instance->resetPassword();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PasswordResetV2Api->resetPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PasswordResetV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordResetV2Api->new();

eval {
    my $result = $api_instance->resetPassword();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordResetV2Api->resetPassword: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PasswordResetV2Api()

try:
    # Reset Password
    api_response = api_instance.reset_password()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordResetV2Api->resetPassword: %s\n" % e)
extern crate PasswordResetV2Api;

pub fn main() {

    let mut context = PasswordResetV2Api::Context::default();
    let result = client.resetPassword(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


sendPasswordReset

Send Password Reset

TODO


/api/v2/user/password/reset/request

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/password/reset/request"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordResetV2Api;

import java.io.File;
import java.util.*;

public class PasswordResetV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PasswordResetV2Api apiInstance = new PasswordResetV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.sendPasswordReset();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetV2Api#sendPasswordReset");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PasswordResetV2Api;

public class PasswordResetV2ApiExample {
    public static void main(String[] args) {
        PasswordResetV2Api apiInstance = new PasswordResetV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.sendPasswordReset();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetV2Api#sendPasswordReset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PasswordResetV2Api *apiInstance = [[PasswordResetV2Api alloc] init];

// Send Password Reset
[apiInstance sendPasswordResetWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PasswordResetV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendPasswordReset(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PasswordResetV2Api();

            try {
                // Send Password Reset
                oas_any_type_not_mapped result = apiInstance.sendPasswordReset();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordResetV2Api.sendPasswordReset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordResetV2Api();

try {
    $result = $api_instance->sendPasswordReset();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PasswordResetV2Api->sendPasswordReset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PasswordResetV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordResetV2Api->new();

eval {
    my $result = $api_instance->sendPasswordReset();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordResetV2Api->sendPasswordReset: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PasswordResetV2Api()

try:
    # Send Password Reset
    api_response = api_instance.send_password_reset()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordResetV2Api->sendPasswordReset: %s\n" % e)
extern crate PasswordResetV2Api;

pub fn main() {

    let mut context = PasswordResetV2Api::Context::default();
    let result = client.sendPasswordReset(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


validateKey

Validate Key

TODO


/api/v2/user/password/reset/validate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/password/reset/validate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordResetV2Api;

import java.io.File;
import java.util.*;

public class PasswordResetV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PasswordResetV2Api apiInstance = new PasswordResetV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.validateKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetV2Api#validateKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PasswordResetV2Api;

public class PasswordResetV2ApiExample {
    public static void main(String[] args) {
        PasswordResetV2Api apiInstance = new PasswordResetV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.validateKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetV2Api#validateKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PasswordResetV2Api *apiInstance = [[PasswordResetV2Api alloc] init];

// Validate Key
[apiInstance validateKeyWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PasswordResetV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateKey(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PasswordResetV2Api();

            try {
                // Validate Key
                oas_any_type_not_mapped result = apiInstance.validateKey();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordResetV2Api.validateKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordResetV2Api();

try {
    $result = $api_instance->validateKey();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PasswordResetV2Api->validateKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PasswordResetV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordResetV2Api->new();

eval {
    my $result = $api_instance->validateKey();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordResetV2Api->validateKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PasswordResetV2Api()

try:
    # Validate Key
    api_response = api_instance.validate_key()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordResetV2Api->validateKey: %s\n" % e)
extern crate PasswordResetV2Api;

pub fn main() {

    let mut context = PasswordResetV2Api::Context::default();
    let result = client.validateKey(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


PaymentsV2

addAddress

Add Address

TODO


/api/v2/payment/address/add

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/address/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#addAddress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#addAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// Add Address
[apiInstance addAddressWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAddress(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // Add Address
                oas_any_type_not_mapped result = apiInstance.addAddress();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.addAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->addAddress();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->addAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->addAddress();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->addAddress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # Add Address
    api_response = api_instance.add_address()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->addAddress: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.addAddress(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


addPaymentMethod

Add Payment Method

TODO


/api/v2/payment/method/add

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/method/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addPaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#addPaymentMethod");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addPaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#addPaymentMethod");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// Add Payment Method
[apiInstance addPaymentMethodWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addPaymentMethod(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // Add Payment Method
                oas_any_type_not_mapped result = apiInstance.addPaymentMethod();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.addPaymentMethod: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->addPaymentMethod();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->addPaymentMethod: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->addPaymentMethod();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->addPaymentMethod: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # Add Payment Method
    api_response = api_instance.add_payment_method()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->addPaymentMethod: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.addPaymentMethod(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


cancelSubscription

Cancel Subscription

TODO


/api/v2/payment/subscription/cancel

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/subscription/cancel"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.cancelSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#cancelSubscription");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.cancelSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#cancelSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// Cancel Subscription
[apiInstance cancelSubscriptionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cancelSubscription(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // Cancel Subscription
                oas_any_type_not_mapped result = apiInstance.cancelSubscription();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.cancelSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->cancelSubscription();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->cancelSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->cancelSubscription();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->cancelSubscription: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # Cancel Subscription
    api_response = api_instance.cancel_subscription()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->cancelSubscription: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.cancelSubscription(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


deleteAddress

Delete Address

TODO


/api/v2/payment/address/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/address/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#deleteAddress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deleteAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#deleteAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// Delete Address
[apiInstance deleteAddressWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAddress(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // Delete Address
                oas_any_type_not_mapped result = apiInstance.deleteAddress();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.deleteAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->deleteAddress();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->deleteAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->deleteAddress();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->deleteAddress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # Delete Address
    api_response = api_instance.delete_address()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->deleteAddress: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.deleteAddress(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


deletePaymentMethod

Delete Payment Method

TODO


/api/v2/payment/method/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/method/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deletePaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#deletePaymentMethod");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deletePaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#deletePaymentMethod");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// Delete Payment Method
[apiInstance deletePaymentMethodWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePaymentMethod(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // Delete Payment Method
                oas_any_type_not_mapped result = apiInstance.deletePaymentMethod();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.deletePaymentMethod: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->deletePaymentMethod();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->deletePaymentMethod: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->deletePaymentMethod();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->deletePaymentMethod: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # Delete Payment Method
    api_response = api_instance.delete_payment_method()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->deletePaymentMethod: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.deletePaymentMethod(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


estimateTaxes

Estimate Taxes

TODO


/api/v2/payment/tax/estimate

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/tax/estimate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.estimateTaxes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#estimateTaxes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.estimateTaxes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#estimateTaxes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// Estimate Taxes
[apiInstance estimateTaxesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.estimateTaxes(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // Estimate Taxes
                oas_any_type_not_mapped result = apiInstance.estimateTaxes();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.estimateTaxes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->estimateTaxes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->estimateTaxes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->estimateTaxes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->estimateTaxes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # Estimate Taxes
    api_response = api_instance.estimate_taxes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->estimateTaxes: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.estimateTaxes(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listAddresses

List Addresses

Retrieve a list of billing addresses saved to the user's account, to be used in conjunction with a payment method when purchasing subscriptions to creators.


/api/v2/payment/address/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/address/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            array[PaymentAddressModel] result = apiInstance.listAddresses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listAddresses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            array[PaymentAddressModel] result = apiInstance.listAddresses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listAddresses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// List Addresses
[apiInstance listAddressesWithCompletionHandler: 
              ^(array[PaymentAddressModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAddresses(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // List Addresses
                array[PaymentAddressModel] result = apiInstance.listAddresses();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.listAddresses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->listAddresses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->listAddresses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->listAddresses();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->listAddresses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # List Addresses
    api_response = api_instance.list_addresses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->listAddresses: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.listAddresses(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listInvoices

List Invoices

Retrieve a list of paid or unpaid subscription invoices for the user.


/api/v2/payment/invoice/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/invoice/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            PaymentInvoiceListV2Response result = apiInstance.listInvoices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listInvoices");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            PaymentInvoiceListV2Response result = apiInstance.listInvoices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listInvoices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// List Invoices
[apiInstance listInvoicesWithCompletionHandler: 
              ^(PaymentInvoiceListV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listInvoices(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // List Invoices
                PaymentInvoiceListV2Response result = apiInstance.listInvoices();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.listInvoices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->listInvoices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->listInvoices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->listInvoices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->listInvoices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # List Invoices
    api_response = api_instance.list_invoices()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->listInvoices: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.listInvoices(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listPaymentMethods

List Payment Methods

Retrieve a list of saved payment methods for the user's account. Payment methods are how the user can pay for their subscription to creators on the platform.


/api/v2/payment/method/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/method/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            array[PaymentMethodModel] result = apiInstance.listPaymentMethods();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listPaymentMethods");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            array[PaymentMethodModel] result = apiInstance.listPaymentMethods();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listPaymentMethods");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// List Payment Methods
[apiInstance listPaymentMethodsWithCompletionHandler: 
              ^(array[PaymentMethodModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPaymentMethods(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // List Payment Methods
                array[PaymentMethodModel] result = apiInstance.listPaymentMethods();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.listPaymentMethods: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->listPaymentMethods();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->listPaymentMethods: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->listPaymentMethods();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->listPaymentMethods: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # List Payment Methods
    api_response = api_instance.list_payment_methods()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->listPaymentMethods: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.listPaymentMethods(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


purchaseSubscription

Purchase Subscription

TODO


/api/v2/payment/subscription/purchase

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/subscription/purchase"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.purchaseSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#purchaseSubscription");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.purchaseSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#purchaseSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// Purchase Subscription
[apiInstance purchaseSubscriptionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.purchaseSubscription(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // Purchase Subscription
                oas_any_type_not_mapped result = apiInstance.purchaseSubscription();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.purchaseSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->purchaseSubscription();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->purchaseSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->purchaseSubscription();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->purchaseSubscription: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # Purchase Subscription
    api_response = api_instance.purchase_subscription()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->purchaseSubscription: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.purchaseSubscription(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


setPrimaryAddress

Set Primary Address

TODO


/api/v2/payment/address/set

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/address/set"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.setPrimaryAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#setPrimaryAddress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.setPrimaryAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#setPrimaryAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// Set Primary Address
[apiInstance setPrimaryAddressWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setPrimaryAddress(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // Set Primary Address
                oas_any_type_not_mapped result = apiInstance.setPrimaryAddress();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.setPrimaryAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->setPrimaryAddress();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->setPrimaryAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->setPrimaryAddress();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->setPrimaryAddress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # Set Primary Address
    api_response = api_instance.set_primary_address()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->setPrimaryAddress: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.setPrimaryAddress(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


setPrimaryPaymentMethod

Set Primary Payment Method

TODO


/api/v2/payment/method/set

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/method/set"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.setPrimaryPaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#setPrimaryPaymentMethod");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.setPrimaryPaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#setPrimaryPaymentMethod");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// Set Primary Payment Method
[apiInstance setPrimaryPaymentMethodWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setPrimaryPaymentMethod(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // Set Primary Payment Method
                oas_any_type_not_mapped result = apiInstance.setPrimaryPaymentMethod();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.setPrimaryPaymentMethod: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->setPrimaryPaymentMethod();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->setPrimaryPaymentMethod: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->setPrimaryPaymentMethod();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->setPrimaryPaymentMethod: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # Set Primary Payment Method
    api_response = api_instance.set_primary_payment_method()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->setPrimaryPaymentMethod: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.setPrimaryPaymentMethod(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateAddress

Update Address

TODO


/api/v2/payment/address/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/address/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#updateAddress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#updateAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// Update Address
[apiInstance updateAddressWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAddress(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // Update Address
                oas_any_type_not_mapped result = apiInstance.updateAddress();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.updateAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->updateAddress();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->updateAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->updateAddress();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->updateAddress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # Update Address
    api_response = api_instance.update_address()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->updateAddress: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.updateAddress(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


webhook

Webhook

TODO - Not used in Floatplane code.


/api/v2/payment/webhook/{paymentProcessor}

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/webhook/{paymentProcessor}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();
        String paymentProcessor = paymentProcessor_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.webhook(paymentProcessor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#webhook");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();
        String paymentProcessor = paymentProcessor_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.webhook(paymentProcessor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#webhook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];
String *paymentProcessor = paymentProcessor_example; //  (default to null)

// Webhook
[apiInstance webhookWith:paymentProcessor
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var paymentProcessor = paymentProcessor_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.webhook(paymentProcessor, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();
            var paymentProcessor = paymentProcessor_example;  // String |  (default to null)

            try {
                // Webhook
                oas_any_type_not_mapped result = apiInstance.webhook(paymentProcessor);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.webhook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();
$paymentProcessor = paymentProcessor_example; // String | 

try {
    $result = $api_instance->webhook($paymentProcessor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->webhook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();
my $paymentProcessor = paymentProcessor_example; # String | 

eval {
    my $result = $api_instance->webhook(paymentProcessor => $paymentProcessor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->webhook: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()
paymentProcessor = paymentProcessor_example # String |  (default to null)

try:
    # Webhook
    api_response = api_instance.webhook(paymentProcessor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->webhook: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {
    let paymentProcessor = paymentProcessor_example; // String

    let mut context = PaymentsV2Api::Context::default();
    let result = client.webhook(paymentProcessor, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
paymentProcessor*
String
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


webhookWithSubprocessor

Webhook With Subprocessor

TODO - Not used in Floatplane code.


/api/v2/payment/webhook/{paymentProcessor}/{subPaymentProcessor}

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/webhook/{paymentProcessor}/{subPaymentProcessor}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();
        String paymentProcessor = paymentProcessor_example; // String | 
        String subPaymentProcessor = subPaymentProcessor_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.webhookWithSubprocessor(paymentProcessor, subPaymentProcessor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#webhookWithSubprocessor");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();
        String paymentProcessor = paymentProcessor_example; // String | 
        String subPaymentProcessor = subPaymentProcessor_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.webhookWithSubprocessor(paymentProcessor, subPaymentProcessor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#webhookWithSubprocessor");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];
String *paymentProcessor = paymentProcessor_example; //  (default to null)
String *subPaymentProcessor = subPaymentProcessor_example; //  (default to null)

// Webhook With Subprocessor
[apiInstance webhookWithSubprocessorWith:paymentProcessor
    subPaymentProcessor:subPaymentProcessor
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var paymentProcessor = paymentProcessor_example; // {String} 
var subPaymentProcessor = subPaymentProcessor_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.webhookWithSubprocessor(paymentProcessor, subPaymentProcessor, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();
            var paymentProcessor = paymentProcessor_example;  // String |  (default to null)
            var subPaymentProcessor = subPaymentProcessor_example;  // String |  (default to null)

            try {
                // Webhook With Subprocessor
                oas_any_type_not_mapped result = apiInstance.webhookWithSubprocessor(paymentProcessor, subPaymentProcessor);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.webhookWithSubprocessor: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();
$paymentProcessor = paymentProcessor_example; // String | 
$subPaymentProcessor = subPaymentProcessor_example; // String | 

try {
    $result = $api_instance->webhookWithSubprocessor($paymentProcessor, $subPaymentProcessor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->webhookWithSubprocessor: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();
my $paymentProcessor = paymentProcessor_example; # String | 
my $subPaymentProcessor = subPaymentProcessor_example; # String | 

eval {
    my $result = $api_instance->webhookWithSubprocessor(paymentProcessor => $paymentProcessor, subPaymentProcessor => $subPaymentProcessor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->webhookWithSubprocessor: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()
paymentProcessor = paymentProcessor_example # String |  (default to null)
subPaymentProcessor = subPaymentProcessor_example # String |  (default to null)

try:
    # Webhook With Subprocessor
    api_response = api_instance.webhook_with_subprocessor(paymentProcessor, subPaymentProcessor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->webhookWithSubprocessor: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {
    let paymentProcessor = paymentProcessor_example; // String
    let subPaymentProcessor = subPaymentProcessor_example; // String

    let mut context = PaymentsV2Api::Context::default();
    let result = client.webhookWithSubprocessor(paymentProcessor, subPaymentProcessor, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
paymentProcessor*
String
Required
subPaymentProcessor*
String
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


PlaylistV2

listPlaylistVideos

List Videos

TODO - Not used in Floatplane code.


/api/v2/playlist/videos

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/playlist/videos"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlaylistV2Api;

import java.io.File;
import java.util.*;

public class PlaylistV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PlaylistV2Api apiInstance = new PlaylistV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listPlaylistVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistV2Api#listPlaylistVideos");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PlaylistV2Api;

public class PlaylistV2ApiExample {
    public static void main(String[] args) {
        PlaylistV2Api apiInstance = new PlaylistV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listPlaylistVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistV2Api#listPlaylistVideos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PlaylistV2Api *apiInstance = [[PlaylistV2Api alloc] init];

// List Videos
[apiInstance listPlaylistVideosWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PlaylistV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPlaylistVideos(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PlaylistV2Api();

            try {
                // List Videos
                oas_any_type_not_mapped result = apiInstance.listPlaylistVideos();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlaylistV2Api.listPlaylistVideos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PlaylistV2Api();

try {
    $result = $api_instance->listPlaylistVideos();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistV2Api->listPlaylistVideos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PlaylistV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PlaylistV2Api->new();

eval {
    my $result = $api_instance->listPlaylistVideos();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlaylistV2Api->listPlaylistVideos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PlaylistV2Api()

try:
    # List Videos
    api_response = api_instance.list_playlist_videos()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlaylistV2Api->listPlaylistVideos: %s\n" % e)
extern crate PlaylistV2Api;

pub fn main() {

    let mut context = PlaylistV2Api::Context::default();
    let result = client.listPlaylistVideos(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


PollV3

closePoll

Close Poll

TODO


/api/v3/poll/close

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/poll/close" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PollV3Api;

import java.io.File;
import java.util.*;

public class PollV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PollV3Api apiInstance = new PollV3Api();
        ClosePollRequest closePollRequest = ; // ClosePollRequest | 

        try {
            oas_any_type_not_mapped result = apiInstance.closePoll(closePollRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#closePoll");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PollV3Api;

public class PollV3ApiExample {
    public static void main(String[] args) {
        PollV3Api apiInstance = new PollV3Api();
        ClosePollRequest closePollRequest = ; // ClosePollRequest | 

        try {
            oas_any_type_not_mapped result = apiInstance.closePoll(closePollRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#closePoll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PollV3Api *apiInstance = [[PollV3Api alloc] init];
ClosePollRequest *closePollRequest = ; // 

// Close Poll
[apiInstance closePollWith:closePollRequest
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PollV3Api()
var closePollRequest = ; // {ClosePollRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.closePoll(closePollRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PollV3Api();
            var closePollRequest = new ClosePollRequest(); // ClosePollRequest | 

            try {
                // Close Poll
                oas_any_type_not_mapped result = apiInstance.closePoll(closePollRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PollV3Api.closePoll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PollV3Api();
$closePollRequest = ; // ClosePollRequest | 

try {
    $result = $api_instance->closePoll($closePollRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PollV3Api->closePoll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PollV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PollV3Api->new();
my $closePollRequest = WWW::OPenAPIClient::Object::ClosePollRequest->new(); # ClosePollRequest | 

eval {
    my $result = $api_instance->closePoll(closePollRequest => $closePollRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PollV3Api->closePoll: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PollV3Api()
closePollRequest =  # ClosePollRequest | 

try:
    # Close Poll
    api_response = api_instance.close_poll(closePollRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PollV3Api->closePoll: %s\n" % e)
extern crate PollV3Api;

pub fn main() {
    let closePollRequest = ; // ClosePollRequest

    let mut context = PollV3Api::Context::default();
    let result = client.closePoll(closePollRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
closePollRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


cmsListPolls

CMS List Polls

TODO


/api/v3/poll/cms/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/poll/cms/list" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PollV3Api;

import java.io.File;
import java.util.*;

public class PollV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PollV3Api apiInstance = new PollV3Api();
        CmsListPollsRequest cmsListPollsRequest = {"creatorId":"59f94c0bdd241b70349eb72b","skip":0,"limit":20,"activeOnly":false}; // CmsListPollsRequest | 

        try {
            oas_any_type_not_mapped result = apiInstance.cmsListPolls(cmsListPollsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#cmsListPolls");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PollV3Api;

public class PollV3ApiExample {
    public static void main(String[] args) {
        PollV3Api apiInstance = new PollV3Api();
        CmsListPollsRequest cmsListPollsRequest = {"creatorId":"59f94c0bdd241b70349eb72b","skip":0,"limit":20,"activeOnly":false}; // CmsListPollsRequest | 

        try {
            oas_any_type_not_mapped result = apiInstance.cmsListPolls(cmsListPollsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#cmsListPolls");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PollV3Api *apiInstance = [[PollV3Api alloc] init];
CmsListPollsRequest *cmsListPollsRequest = {"creatorId":"59f94c0bdd241b70349eb72b","skip":0,"limit":20,"activeOnly":false}; // 

// CMS List Polls
[apiInstance cmsListPollsWith:cmsListPollsRequest
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PollV3Api()
var cmsListPollsRequest = {"creatorId":"59f94c0bdd241b70349eb72b","skip":0,"limit":20,"activeOnly":false}; // {CmsListPollsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cmsListPolls(cmsListPollsRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PollV3Api();
            var cmsListPollsRequest = new CmsListPollsRequest(); // CmsListPollsRequest | 

            try {
                // CMS List Polls
                oas_any_type_not_mapped result = apiInstance.cmsListPolls(cmsListPollsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PollV3Api.cmsListPolls: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PollV3Api();
$cmsListPollsRequest = {"creatorId":"59f94c0bdd241b70349eb72b","skip":0,"limit":20,"activeOnly":false}; // CmsListPollsRequest | 

try {
    $result = $api_instance->cmsListPolls($cmsListPollsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PollV3Api->cmsListPolls: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PollV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PollV3Api->new();
my $cmsListPollsRequest = WWW::OPenAPIClient::Object::CmsListPollsRequest->new(); # CmsListPollsRequest | 

eval {
    my $result = $api_instance->cmsListPolls(cmsListPollsRequest => $cmsListPollsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PollV3Api->cmsListPolls: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PollV3Api()
cmsListPollsRequest = {"creatorId":"59f94c0bdd241b70349eb72b","skip":0,"limit":20,"activeOnly":false} # CmsListPollsRequest | 

try:
    # CMS List Polls
    api_response = api_instance.cms_list_polls(cmsListPollsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PollV3Api->cmsListPolls: %s\n" % e)
extern crate PollV3Api;

pub fn main() {
    let cmsListPollsRequest = {"creatorId":"59f94c0bdd241b70349eb72b","skip":0,"limit":20,"activeOnly":false}; // CmsListPollsRequest

    let mut context = PollV3Api::Context::default();
    let result = client.cmsListPolls(cmsListPollsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
cmsListPollsRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


createLivePoll

Create Live Poll

TODO


/api/v3/poll/live/create

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/poll/live/create" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PollV3Api;

import java.io.File;
import java.util.*;

public class PollV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PollV3Api apiInstance = new PollV3Api();
        CreateLivePollRequest createLivePollRequest = ; // CreateLivePollRequest | 

        try {
            oas_any_type_not_mapped result = apiInstance.createLivePoll(createLivePollRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#createLivePoll");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PollV3Api;

public class PollV3ApiExample {
    public static void main(String[] args) {
        PollV3Api apiInstance = new PollV3Api();
        CreateLivePollRequest createLivePollRequest = ; // CreateLivePollRequest | 

        try {
            oas_any_type_not_mapped result = apiInstance.createLivePoll(createLivePollRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#createLivePoll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PollV3Api *apiInstance = [[PollV3Api alloc] init];
CreateLivePollRequest *createLivePollRequest = ; // 

// Create Live Poll
[apiInstance createLivePollWith:createLivePollRequest
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PollV3Api()
var createLivePollRequest = ; // {CreateLivePollRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createLivePoll(createLivePollRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PollV3Api();
            var createLivePollRequest = new CreateLivePollRequest(); // CreateLivePollRequest | 

            try {
                // Create Live Poll
                oas_any_type_not_mapped result = apiInstance.createLivePoll(createLivePollRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PollV3Api.createLivePoll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PollV3Api();
$createLivePollRequest = ; // CreateLivePollRequest | 

try {
    $result = $api_instance->createLivePoll($createLivePollRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PollV3Api->createLivePoll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PollV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PollV3Api->new();
my $createLivePollRequest = WWW::OPenAPIClient::Object::CreateLivePollRequest->new(); # CreateLivePollRequest | 

eval {
    my $result = $api_instance->createLivePoll(createLivePollRequest => $createLivePollRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PollV3Api->createLivePoll: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PollV3Api()
createLivePollRequest =  # CreateLivePollRequest | 

try:
    # Create Live Poll
    api_response = api_instance.create_live_poll(createLivePollRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PollV3Api->createLivePoll: %s\n" % e)
extern crate PollV3Api;

pub fn main() {
    let createLivePollRequest = ; // CreateLivePollRequest

    let mut context = PollV3Api::Context::default();
    let result = client.createLivePoll(createLivePollRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
createLivePollRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


joinLiveRoom

Poll Join Live Room

Used in Socket.IO/WebSocket connections. See the AsyncAPI documentation for more information. This should not be used on a raw HTTP connection.


/api/v3/poll/live/joinroom

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/poll/live/joinroom"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PollV3Api;

import java.io.File;
import java.util.*;

public class PollV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.joinLiveRoom();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#joinLiveRoom");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PollV3Api;

public class PollV3ApiExample {
    public static void main(String[] args) {
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.joinLiveRoom();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#joinLiveRoom");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PollV3Api *apiInstance = [[PollV3Api alloc] init];

// Poll Join Live Room
[apiInstance joinLiveRoomWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PollV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.joinLiveRoom(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PollV3Api();

            try {
                // Poll Join Live Room
                oas_any_type_not_mapped result = apiInstance.joinLiveRoom();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PollV3Api.joinLiveRoom: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PollV3Api();

try {
    $result = $api_instance->joinLiveRoom();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PollV3Api->joinLiveRoom: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PollV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PollV3Api->new();

eval {
    my $result = $api_instance->joinLiveRoom();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PollV3Api->joinLiveRoom: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PollV3Api()

try:
    # Poll Join Live Room
    api_response = api_instance.join_live_room()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PollV3Api->joinLiveRoom: %s\n" % e)
extern crate PollV3Api;

pub fn main() {

    let mut context = PollV3Api::Context::default();
    let result = client.joinLiveRoom(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


joinLiveRoomModerator

Poll Join Live Room Moderator

TODO - Used in Socket.IO/WebSocket connections. See the AsyncAPI documentation for more information. This should not be used on a raw HTTP connection.


/api/v3/poll/live/joinLiveRoomModerator

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/poll/live/joinLiveRoomModerator"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PollV3Api;

import java.io.File;
import java.util.*;

public class PollV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.joinLiveRoomModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#joinLiveRoomModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PollV3Api;

public class PollV3ApiExample {
    public static void main(String[] args) {
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.joinLiveRoomModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#joinLiveRoomModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PollV3Api *apiInstance = [[PollV3Api alloc] init];

// Poll Join Live Room Moderator
[apiInstance joinLiveRoomModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PollV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.joinLiveRoomModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PollV3Api();

            try {
                // Poll Join Live Room Moderator
                oas_any_type_not_mapped result = apiInstance.joinLiveRoomModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PollV3Api.joinLiveRoomModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PollV3Api();

try {
    $result = $api_instance->joinLiveRoomModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PollV3Api->joinLiveRoomModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PollV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PollV3Api->new();

eval {
    my $result = $api_instance->joinLiveRoomModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PollV3Api->joinLiveRoomModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PollV3Api()

try:
    # Poll Join Live Room Moderator
    api_response = api_instance.join_live_room_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PollV3Api->joinLiveRoomModerator: %s\n" % e)
extern crate PollV3Api;

pub fn main() {

    let mut context = PollV3Api::Context::default();
    let result = client.joinLiveRoomModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


leaveLiveRoom

Poll Leave Live Room

Used in Socket.IO/WebSocket connections. See the AsyncAPI documentation for more information. This should not be used on a raw HTTP connection.


/api/v3/poll/live/leaveLiveRoom

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/poll/live/leaveLiveRoom"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PollV3Api;

import java.io.File;
import java.util.*;

public class PollV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.leaveLiveRoom();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#leaveLiveRoom");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PollV3Api;

public class PollV3ApiExample {
    public static void main(String[] args) {
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.leaveLiveRoom();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#leaveLiveRoom");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PollV3Api *apiInstance = [[PollV3Api alloc] init];

// Poll Leave Live Room
[apiInstance leaveLiveRoomWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PollV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.leaveLiveRoom(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PollV3Api();

            try {
                // Poll Leave Live Room
                oas_any_type_not_mapped result = apiInstance.leaveLiveRoom();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PollV3Api.leaveLiveRoom: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PollV3Api();

try {
    $result = $api_instance->leaveLiveRoom();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PollV3Api->leaveLiveRoom: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PollV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PollV3Api->new();

eval {
    my $result = $api_instance->leaveLiveRoom();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PollV3Api->leaveLiveRoom: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PollV3Api()

try:
    # Poll Leave Live Room
    api_response = api_instance.leave_live_room()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PollV3Api->leaveLiveRoom: %s\n" % e)
extern crate PollV3Api;

pub fn main() {

    let mut context = PollV3Api::Context::default();
    let result = client.leaveLiveRoom(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


leaveLiveRoomModerator

Poll Leave Live Room Moderator

TODO - Used in Socket.IO/WebSocket connections. See the AsyncAPI documentation for more information. This should not be used on a raw HTTP connection.


/api/v3/poll/live/leaveLiveRoomModerator

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/poll/live/leaveLiveRoomModerator"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PollV3Api;

import java.io.File;
import java.util.*;

public class PollV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.leaveLiveRoomModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#leaveLiveRoomModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PollV3Api;

public class PollV3ApiExample {
    public static void main(String[] args) {
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.leaveLiveRoomModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#leaveLiveRoomModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PollV3Api *apiInstance = [[PollV3Api alloc] init];

// Poll Leave Live Room Moderator
[apiInstance leaveLiveRoomModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PollV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.leaveLiveRoomModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PollV3Api();

            try {
                // Poll Leave Live Room Moderator
                oas_any_type_not_mapped result = apiInstance.leaveLiveRoomModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PollV3Api.leaveLiveRoomModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PollV3Api();

try {
    $result = $api_instance->leaveLiveRoomModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PollV3Api->leaveLiveRoomModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PollV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PollV3Api->new();

eval {
    my $result = $api_instance->leaveLiveRoomModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PollV3Api->leaveLiveRoomModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PollV3Api()

try:
    # Poll Leave Live Room Moderator
    api_response = api_instance.leave_live_room_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PollV3Api->leaveLiveRoomModerator: %s\n" % e)
extern crate PollV3Api;

pub fn main() {

    let mut context = PollV3Api::Context::default();
    let result = client.leaveLiveRoomModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


votePoll

Vote Poll

Vote on an option of a poll. Voting a second time or attempting to change a choice may result in an error.


/api/v3/poll/votePoll

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/poll/votePoll" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PollV3Api;

import java.io.File;
import java.util.*;

public class PollV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PollV3Api apiInstance = new PollV3Api();
        VotePollRequest votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // VotePollRequest | 

        try {
            oas_any_type_not_mapped result = apiInstance.votePoll(votePollRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#votePoll");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PollV3Api;

public class PollV3ApiExample {
    public static void main(String[] args) {
        PollV3Api apiInstance = new PollV3Api();
        VotePollRequest votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // VotePollRequest | 

        try {
            oas_any_type_not_mapped result = apiInstance.votePoll(votePollRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#votePoll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
PollV3Api *apiInstance = [[PollV3Api alloc] init];
VotePollRequest *votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // 

// Vote Poll
[apiInstance votePollWith:votePollRequest
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PollV3Api()
var votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // {VotePollRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.votePoll(votePollRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PollV3Api();
            var votePollRequest = new VotePollRequest(); // VotePollRequest | 

            try {
                // Vote Poll
                oas_any_type_not_mapped result = apiInstance.votePoll(votePollRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PollV3Api.votePoll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PollV3Api();
$votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // VotePollRequest | 

try {
    $result = $api_instance->votePoll($votePollRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PollV3Api->votePoll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PollV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PollV3Api->new();
my $votePollRequest = WWW::OPenAPIClient::Object::VotePollRequest->new(); # VotePollRequest | 

eval {
    my $result = $api_instance->votePoll(votePollRequest => $votePollRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PollV3Api->votePoll: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PollV3Api()
votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1} # VotePollRequest | 

try:
    # Vote Poll
    api_response = api_instance.vote_poll(votePollRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PollV3Api->votePoll: %s\n" % e)
extern crate PollV3Api;

pub fn main() {
    let votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // VotePollRequest

    let mut context = PollV3Api::Context::default();
    let result = client.votePoll(votePollRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
votePollRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


RedirectV3

redirectYTLatest

Redirect to YouTube Latest Video

Redirects (HTTP 302) the user to the latest LMG video for a given LMG channel key. For example, visiting this URL with a `channelKey` of `sc`, it will take you directly to the latest Short Circuit video on YouTube. Unknown if this works for non-LMG creators for their channels. Not used in Floatplane code.


/api/v3/redirect-yt-latest/{channelKey}

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/redirect-yt-latest/{channelKey}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RedirectV3Api;

import java.io.File;
import java.util.*;

public class RedirectV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        RedirectV3Api apiInstance = new RedirectV3Api();
        String channelKey = channelKey_example; // String | 

        try {
            ErrorModel result = apiInstance.redirectYTLatest(channelKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectV3Api#redirectYTLatest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RedirectV3Api;

public class RedirectV3ApiExample {
    public static void main(String[] args) {
        RedirectV3Api apiInstance = new RedirectV3Api();
        String channelKey = channelKey_example; // String | 

        try {
            ErrorModel result = apiInstance.redirectYTLatest(channelKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectV3Api#redirectYTLatest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
RedirectV3Api *apiInstance = [[RedirectV3Api alloc] init];
String *channelKey = channelKey_example; //  (default to null)

// Redirect to YouTube Latest Video
[apiInstance redirectYTLatestWith:channelKey
              completionHandler: ^(ErrorModel output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.RedirectV3Api()
var channelKey = channelKey_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.redirectYTLatest(channelKey, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new RedirectV3Api();
            var channelKey = channelKey_example;  // String |  (default to null)

            try {
                // Redirect to YouTube Latest Video
                ErrorModel result = apiInstance.redirectYTLatest(channelKey);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RedirectV3Api.redirectYTLatest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RedirectV3Api();
$channelKey = channelKey_example; // String | 

try {
    $result = $api_instance->redirectYTLatest($channelKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedirectV3Api->redirectYTLatest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RedirectV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RedirectV3Api->new();
my $channelKey = channelKey_example; # String | 

eval {
    my $result = $api_instance->redirectYTLatest(channelKey => $channelKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RedirectV3Api->redirectYTLatest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.RedirectV3Api()
channelKey = channelKey_example # String |  (default to null)

try:
    # Redirect to YouTube Latest Video
    api_response = api_instance.redirect_yt_latest(channelKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RedirectV3Api->redirectYTLatest: %s\n" % e)
extern crate RedirectV3Api;

pub fn main() {
    let channelKey = channelKey_example; // String

    let mut context = RedirectV3Api::Context::default();
    let result = client.redirectYTLatest(channelKey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
channelKey*
String
Required

Responses

Name Type Format Description
Location String A YouTube URL for a video.

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


SocketV2

subscribeUser

Subscribe User

TODO - Not used in Floatplane code.


/api/v2/socket/subscribe/user

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/socket/subscribe/user"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SocketV2Api;

import java.io.File;
import java.util.*;

public class SocketV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SocketV2Api apiInstance = new SocketV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.subscribeUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV2Api#subscribeUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SocketV2Api;

public class SocketV2ApiExample {
    public static void main(String[] args) {
        SocketV2Api apiInstance = new SocketV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.subscribeUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV2Api#subscribeUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SocketV2Api *apiInstance = [[SocketV2Api alloc] init];

// Subscribe User
[apiInstance subscribeUserWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SocketV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.subscribeUser(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SocketV2Api();

            try {
                // Subscribe User
                oas_any_type_not_mapped result = apiInstance.subscribeUser();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SocketV2Api.subscribeUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SocketV2Api();

try {
    $result = $api_instance->subscribeUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SocketV2Api->subscribeUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SocketV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SocketV2Api->new();

eval {
    my $result = $api_instance->subscribeUser();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SocketV2Api->subscribeUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SocketV2Api()

try:
    # Subscribe User
    api_response = api_instance.subscribe_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocketV2Api->subscribeUser: %s\n" % e)
extern crate SocketV2Api;

pub fn main() {

    let mut context = SocketV2Api::Context::default();
    let result = client.subscribeUser(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


subscribeUserById

Subscribe User By Id

TODO - Not used in Floatplane code.


/api/v2/socket/subscribe/user/{id}

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/socket/subscribe/user/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SocketV2Api;

import java.io.File;
import java.util.*;

public class SocketV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SocketV2Api apiInstance = new SocketV2Api();
        String id = id_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.subscribeUserById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV2Api#subscribeUserById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SocketV2Api;

public class SocketV2ApiExample {
    public static void main(String[] args) {
        SocketV2Api apiInstance = new SocketV2Api();
        String id = id_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.subscribeUserById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV2Api#subscribeUserById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SocketV2Api *apiInstance = [[SocketV2Api alloc] init];
String *id = id_example; //  (default to null)

// Subscribe User By Id
[apiInstance subscribeUserByIdWith:id
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SocketV2Api()
var id = id_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.subscribeUserById(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SocketV2Api();
            var id = id_example;  // String |  (default to null)

            try {
                // Subscribe User By Id
                oas_any_type_not_mapped result = apiInstance.subscribeUserById(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SocketV2Api.subscribeUserById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SocketV2Api();
$id = id_example; // String | 

try {
    $result = $api_instance->subscribeUserById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SocketV2Api->subscribeUserById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SocketV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SocketV2Api->new();
my $id = id_example; # String | 

eval {
    my $result = $api_instance->subscribeUserById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SocketV2Api->subscribeUserById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SocketV2Api()
id = id_example # String |  (default to null)

try:
    # Subscribe User By Id
    api_response = api_instance.subscribe_user_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocketV2Api->subscribeUserById: %s\n" % e)
extern crate SocketV2Api;

pub fn main() {
    let id = id_example; // String

    let mut context = SocketV2Api::Context::default();
    let result = client.subscribeUserById(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


SocketV3

disconnectSocket

Disconnect

Used in Socket.IO/WebSocket connections. See the AsyncAPI documentation for more information. This should not be used on a raw HTTP connection.


/api/v3/socket/disconnect

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/socket/disconnect"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SocketV3Api;

import java.io.File;
import java.util.*;

public class SocketV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SocketV3Api apiInstance = new SocketV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.disconnectSocket();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV3Api#disconnectSocket");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SocketV3Api;

public class SocketV3ApiExample {
    public static void main(String[] args) {
        SocketV3Api apiInstance = new SocketV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.disconnectSocket();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV3Api#disconnectSocket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SocketV3Api *apiInstance = [[SocketV3Api alloc] init];

// Disconnect
[apiInstance disconnectSocketWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SocketV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disconnectSocket(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SocketV3Api();

            try {
                // Disconnect
                oas_any_type_not_mapped result = apiInstance.disconnectSocket();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SocketV3Api.disconnectSocket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SocketV3Api();

try {
    $result = $api_instance->disconnectSocket();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SocketV3Api->disconnectSocket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SocketV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SocketV3Api->new();

eval {
    my $result = $api_instance->disconnectSocket();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SocketV3Api->disconnectSocket: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SocketV3Api()

try:
    # Disconnect
    api_response = api_instance.disconnect_socket()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocketV3Api->disconnectSocket: %s\n" % e)
extern crate SocketV3Api;

pub fn main() {

    let mut context = SocketV3Api::Context::default();
    let result = client.disconnectSocket(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


socketConnect

Connect

Used in Socket.IO/WebSocket connections. See the AsyncAPI documentation for more information. This should not be used on a raw HTTP connection.


/api/v3/socket/connect

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/socket/connect"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SocketV3Api;

import java.io.File;
import java.util.*;

public class SocketV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SocketV3Api apiInstance = new SocketV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.socketConnect();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV3Api#socketConnect");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SocketV3Api;

public class SocketV3ApiExample {
    public static void main(String[] args) {
        SocketV3Api apiInstance = new SocketV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.socketConnect();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV3Api#socketConnect");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SocketV3Api *apiInstance = [[SocketV3Api alloc] init];

// Connect
[apiInstance socketConnectWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SocketV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.socketConnect(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SocketV3Api();

            try {
                // Connect
                oas_any_type_not_mapped result = apiInstance.socketConnect();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SocketV3Api.socketConnect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SocketV3Api();

try {
    $result = $api_instance->socketConnect();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SocketV3Api->socketConnect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SocketV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SocketV3Api->new();

eval {
    my $result = $api_instance->socketConnect();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SocketV3Api->socketConnect: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SocketV3Api()

try:
    # Connect
    api_response = api_instance.socket_connect()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocketV3Api->socketConnect: %s\n" % e)
extern crate SocketV3Api;

pub fn main() {

    let mut context = SocketV3Api::Context::default();
    let result = client.socketConnect(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


StripeV2

retrievePublicKey

Retrieve Public Key

TODO


/api/v2/payment/stripe/pk

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/stripe/pk"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StripeV2Api;

import java.io.File;
import java.util.*;

public class StripeV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        StripeV2Api apiInstance = new StripeV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.retrievePublicKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StripeV2Api#retrievePublicKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StripeV2Api;

public class StripeV2ApiExample {
    public static void main(String[] args) {
        StripeV2Api apiInstance = new StripeV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.retrievePublicKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StripeV2Api#retrievePublicKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
StripeV2Api *apiInstance = [[StripeV2Api alloc] init];

// Retrieve Public Key
[apiInstance retrievePublicKeyWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.StripeV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrievePublicKey(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new StripeV2Api();

            try {
                // Retrieve Public Key
                oas_any_type_not_mapped result = apiInstance.retrievePublicKey();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StripeV2Api.retrievePublicKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StripeV2Api();

try {
    $result = $api_instance->retrievePublicKey();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StripeV2Api->retrievePublicKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StripeV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StripeV2Api->new();

eval {
    my $result = $api_instance->retrievePublicKey();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StripeV2Api->retrievePublicKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.StripeV2Api()

try:
    # Retrieve Public Key
    api_response = api_instance.retrieve_public_key()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StripeV2Api->retrievePublicKey: %s\n" % e)
extern crate StripeV2Api;

pub fn main() {

    let mut context = StripeV2Api::Context::default();
    let result = client.retrievePublicKey(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


SubscriptionsV2

doesUserHaveSubV2

Does User Have Sub

TODO - Not used in Floatplane code.


/api/v2/user/subscribed

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/subscribed"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriptionsV2Api;

import java.io.File;
import java.util.*;

public class SubscriptionsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SubscriptionsV2Api apiInstance = new SubscriptionsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsV2Api#doesUserHaveSubV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriptionsV2Api;

public class SubscriptionsV2ApiExample {
    public static void main(String[] args) {
        SubscriptionsV2Api apiInstance = new SubscriptionsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsV2Api#doesUserHaveSubV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SubscriptionsV2Api *apiInstance = [[SubscriptionsV2Api alloc] init];

// Does User Have Sub
[apiInstance doesUserHaveSubV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SubscriptionsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.doesUserHaveSubV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SubscriptionsV2Api();

            try {
                // Does User Have Sub
                oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriptionsV2Api.doesUserHaveSubV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriptionsV2Api();

try {
    $result = $api_instance->doesUserHaveSubV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsV2Api->doesUserHaveSubV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriptionsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriptionsV2Api->new();

eval {
    my $result = $api_instance->doesUserHaveSubV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriptionsV2Api->doesUserHaveSubV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SubscriptionsV2Api()

try:
    # Does User Have Sub
    api_response = api_instance.does_user_have_sub_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionsV2Api->doesUserHaveSubV2: %s\n" % e)
extern crate SubscriptionsV2Api;

pub fn main() {

    let mut context = SubscriptionsV2Api::Context::default();
    let result = client.doesUserHaveSubV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listUserSubscriptionsV2

List User Subscriptions

TODO - Not used in Floatplane code.


/api/v2/user/subscriptions

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/subscriptions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriptionsV2Api;

import java.io.File;
import java.util.*;

public class SubscriptionsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SubscriptionsV2Api apiInstance = new SubscriptionsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listUserSubscriptionsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsV2Api#listUserSubscriptionsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriptionsV2Api;

public class SubscriptionsV2ApiExample {
    public static void main(String[] args) {
        SubscriptionsV2Api apiInstance = new SubscriptionsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.listUserSubscriptionsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsV2Api#listUserSubscriptionsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SubscriptionsV2Api *apiInstance = [[SubscriptionsV2Api alloc] init];

// List User Subscriptions
[apiInstance listUserSubscriptionsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SubscriptionsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUserSubscriptionsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SubscriptionsV2Api();

            try {
                // List User Subscriptions
                oas_any_type_not_mapped result = apiInstance.listUserSubscriptionsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriptionsV2Api.listUserSubscriptionsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriptionsV2Api();

try {
    $result = $api_instance->listUserSubscriptionsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsV2Api->listUserSubscriptionsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriptionsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriptionsV2Api->new();

eval {
    my $result = $api_instance->listUserSubscriptionsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriptionsV2Api->listUserSubscriptionsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SubscriptionsV2Api()

try:
    # List User Subscriptions
    api_response = api_instance.list_user_subscriptions_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionsV2Api->listUserSubscriptionsV2: %s\n" % e)
extern crate SubscriptionsV2Api;

pub fn main() {

    let mut context = SubscriptionsV2Api::Context::default();
    let result = client.listUserSubscriptionsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


SubscriptionsV3

doesUserHaveSubV3

Does User Have Sub

TODO - Not used in Floatplane code.


/api/v3/user/subscribed

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/subscribed"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriptionsV3Api;

import java.io.File;
import java.util.*;

public class SubscriptionsV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SubscriptionsV3Api apiInstance = new SubscriptionsV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsV3Api#doesUserHaveSubV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriptionsV3Api;

public class SubscriptionsV3ApiExample {
    public static void main(String[] args) {
        SubscriptionsV3Api apiInstance = new SubscriptionsV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsV3Api#doesUserHaveSubV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SubscriptionsV3Api *apiInstance = [[SubscriptionsV3Api alloc] init];

// Does User Have Sub
[apiInstance doesUserHaveSubV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SubscriptionsV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.doesUserHaveSubV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SubscriptionsV3Api();

            try {
                // Does User Have Sub
                oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriptionsV3Api.doesUserHaveSubV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriptionsV3Api();

try {
    $result = $api_instance->doesUserHaveSubV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsV3Api->doesUserHaveSubV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriptionsV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriptionsV3Api->new();

eval {
    my $result = $api_instance->doesUserHaveSubV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriptionsV3Api->doesUserHaveSubV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SubscriptionsV3Api()

try:
    # Does User Have Sub
    api_response = api_instance.does_user_have_sub_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionsV3Api->doesUserHaveSubV3: %s\n" % e)
extern crate SubscriptionsV3Api;

pub fn main() {

    let mut context = SubscriptionsV3Api::Context::default();
    let result = client.doesUserHaveSubV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listUserSubscriptionsV3

List User Subscriptions

Retrieve a list of all active subscriptions for the user.


/api/v3/user/subscriptions

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/subscriptions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriptionsV3Api;

import java.io.File;
import java.util.*;

public class SubscriptionsV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SubscriptionsV3Api apiInstance = new SubscriptionsV3Api();

        try {
            array[UserSubscriptionModel] result = apiInstance.listUserSubscriptionsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsV3Api#listUserSubscriptionsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriptionsV3Api;

public class SubscriptionsV3ApiExample {
    public static void main(String[] args) {
        SubscriptionsV3Api apiInstance = new SubscriptionsV3Api();

        try {
            array[UserSubscriptionModel] result = apiInstance.listUserSubscriptionsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsV3Api#listUserSubscriptionsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SubscriptionsV3Api *apiInstance = [[SubscriptionsV3Api alloc] init];

// List User Subscriptions
[apiInstance listUserSubscriptionsV3WithCompletionHandler: 
              ^(array[UserSubscriptionModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SubscriptionsV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUserSubscriptionsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SubscriptionsV3Api();

            try {
                // List User Subscriptions
                array[UserSubscriptionModel] result = apiInstance.listUserSubscriptionsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriptionsV3Api.listUserSubscriptionsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriptionsV3Api();

try {
    $result = $api_instance->listUserSubscriptionsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsV3Api->listUserSubscriptionsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriptionsV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriptionsV3Api->new();

eval {
    my $result = $api_instance->listUserSubscriptionsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriptionsV3Api->listUserSubscriptionsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SubscriptionsV3Api()

try:
    # List User Subscriptions
    api_response = api_instance.list_user_subscriptions_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionsV3Api->listUserSubscriptionsV3: %s\n" % e)
extern crate SubscriptionsV3Api;

pub fn main() {

    let mut context = SubscriptionsV3Api::Context::default();
    let result = client.listUserSubscriptionsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


SupportV2

getTicketTypes

Get Ticket Types

TODO


/api/v2/support/ticket/types

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/support/ticket/types"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SupportV2Api;

import java.io.File;
import java.util.*;

public class SupportV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SupportV2Api apiInstance = new SupportV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getTicketTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupportV2Api#getTicketTypes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SupportV2Api;

public class SupportV2ApiExample {
    public static void main(String[] args) {
        SupportV2Api apiInstance = new SupportV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getTicketTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupportV2Api#getTicketTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SupportV2Api *apiInstance = [[SupportV2Api alloc] init];

// Get Ticket Types
[apiInstance getTicketTypesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SupportV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTicketTypes(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SupportV2Api();

            try {
                // Get Ticket Types
                oas_any_type_not_mapped result = apiInstance.getTicketTypes();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SupportV2Api.getTicketTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SupportV2Api();

try {
    $result = $api_instance->getTicketTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SupportV2Api->getTicketTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SupportV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SupportV2Api->new();

eval {
    my $result = $api_instance->getTicketTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SupportV2Api->getTicketTypes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SupportV2Api()

try:
    # Get Ticket Types
    api_response = api_instance.get_ticket_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SupportV2Api->getTicketTypes: %s\n" % e)
extern crate SupportV2Api;

pub fn main() {

    let mut context = SupportV2Api::Context::default();
    let result = client.getTicketTypes(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


submitSupport

Submit Support

TODO


/api/v2/support/

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/support/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SupportV2Api;

import java.io.File;
import java.util.*;

public class SupportV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SupportV2Api apiInstance = new SupportV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.submitSupport();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupportV2Api#submitSupport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SupportV2Api;

public class SupportV2ApiExample {
    public static void main(String[] args) {
        SupportV2Api apiInstance = new SupportV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.submitSupport();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupportV2Api#submitSupport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SupportV2Api *apiInstance = [[SupportV2Api alloc] init];

// Submit Support
[apiInstance submitSupportWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SupportV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.submitSupport(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SupportV2Api();

            try {
                // Submit Support
                oas_any_type_not_mapped result = apiInstance.submitSupport();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SupportV2Api.submitSupport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SupportV2Api();

try {
    $result = $api_instance->submitSupport();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SupportV2Api->submitSupport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SupportV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SupportV2Api->new();

eval {
    my $result = $api_instance->submitSupport();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SupportV2Api->submitSupport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SupportV2Api()

try:
    # Submit Support
    api_response = api_instance.submit_support()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SupportV2Api->submitSupport: %s\n" % e)
extern crate SupportV2Api;

pub fn main() {

    let mut context = SupportV2Api::Context::default();
    let result = client.submitSupport(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


SyncV2

disconnectSync

Disconnect

TODO - Not used in Floatplane code.


/api/v2/sync/disconnect

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/sync/disconnect"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SyncV2Api;

import java.io.File;
import java.util.*;

public class SyncV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SyncV2Api apiInstance = new SyncV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.disconnectSync();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SyncV2Api#disconnectSync");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SyncV2Api;

public class SyncV2ApiExample {
    public static void main(String[] args) {
        SyncV2Api apiInstance = new SyncV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.disconnectSync();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SyncV2Api#disconnectSync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SyncV2Api *apiInstance = [[SyncV2Api alloc] init];

// Disconnect
[apiInstance disconnectSyncWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SyncV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disconnectSync(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SyncV2Api();

            try {
                // Disconnect
                oas_any_type_not_mapped result = apiInstance.disconnectSync();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SyncV2Api.disconnectSync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SyncV2Api();

try {
    $result = $api_instance->disconnectSync();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SyncV2Api->disconnectSync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SyncV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SyncV2Api->new();

eval {
    my $result = $api_instance->disconnectSync();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SyncV2Api->disconnectSync: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SyncV2Api()

try:
    # Disconnect
    api_response = api_instance.disconnect_sync()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SyncV2Api->disconnectSync: %s\n" % e)
extern crate SyncV2Api;

pub fn main() {

    let mut context = SyncV2Api::Context::default();
    let result = client.disconnectSync(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


syncConnect

Connect

TODO - Not used in Floatplane code.


/api/v2/sync/connect

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/sync/connect"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SyncV2Api;

import java.io.File;
import java.util.*;

public class SyncV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SyncV2Api apiInstance = new SyncV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.syncConnect();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SyncV2Api#syncConnect");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SyncV2Api;

public class SyncV2ApiExample {
    public static void main(String[] args) {
        SyncV2Api apiInstance = new SyncV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.syncConnect();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SyncV2Api#syncConnect");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
SyncV2Api *apiInstance = [[SyncV2Api alloc] init];

// Connect
[apiInstance syncConnectWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SyncV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.syncConnect(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SyncV2Api();

            try {
                // Connect
                oas_any_type_not_mapped result = apiInstance.syncConnect();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SyncV2Api.syncConnect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SyncV2Api();

try {
    $result = $api_instance->syncConnect();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SyncV2Api->syncConnect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SyncV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SyncV2Api->new();

eval {
    my $result = $api_instance->syncConnect();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SyncV2Api->syncConnect: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SyncV2Api()

try:
    # Connect
    api_response = api_instance.sync_connect()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SyncV2Api->syncConnect: %s\n" % e)
extern crate SyncV2Api;

pub fn main() {

    let mut context = SyncV2Api::Context::default();
    let result = client.syncConnect(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ThumbnailUpdateUnsubscribeV3

thumbnailUpdateUnsubscribe

Thumbnail Update Unsubscribe

TODO - Not used in Floatplane code.


/api/v3/content/thumbnail/unsubscribe

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/thumbnail/unsubscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ThumbnailUpdateUnsubscribeV3Api;

import java.io.File;
import java.util.*;

public class ThumbnailUpdateUnsubscribeV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ThumbnailUpdateUnsubscribeV3Api apiInstance = new ThumbnailUpdateUnsubscribeV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.thumbnailUpdateUnsubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThumbnailUpdateUnsubscribeV3Api#thumbnailUpdateUnsubscribe");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ThumbnailUpdateUnsubscribeV3Api;

public class ThumbnailUpdateUnsubscribeV3ApiExample {
    public static void main(String[] args) {
        ThumbnailUpdateUnsubscribeV3Api apiInstance = new ThumbnailUpdateUnsubscribeV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.thumbnailUpdateUnsubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThumbnailUpdateUnsubscribeV3Api#thumbnailUpdateUnsubscribe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ThumbnailUpdateUnsubscribeV3Api *apiInstance = [[ThumbnailUpdateUnsubscribeV3Api alloc] init];

// Thumbnail Update Unsubscribe
[apiInstance thumbnailUpdateUnsubscribeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ThumbnailUpdateUnsubscribeV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.thumbnailUpdateUnsubscribe(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ThumbnailUpdateUnsubscribeV3Api();

            try {
                // Thumbnail Update Unsubscribe
                oas_any_type_not_mapped result = apiInstance.thumbnailUpdateUnsubscribe();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ThumbnailUpdateUnsubscribeV3Api.thumbnailUpdateUnsubscribe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ThumbnailUpdateUnsubscribeV3Api();

try {
    $result = $api_instance->thumbnailUpdateUnsubscribe();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ThumbnailUpdateUnsubscribeV3Api->thumbnailUpdateUnsubscribe: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ThumbnailUpdateUnsubscribeV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ThumbnailUpdateUnsubscribeV3Api->new();

eval {
    my $result = $api_instance->thumbnailUpdateUnsubscribe();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ThumbnailUpdateUnsubscribeV3Api->thumbnailUpdateUnsubscribe: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ThumbnailUpdateUnsubscribeV3Api()

try:
    # Thumbnail Update Unsubscribe
    api_response = api_instance.thumbnail_update_unsubscribe()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ThumbnailUpdateUnsubscribeV3Api->thumbnailUpdateUnsubscribe: %s\n" % e)
extern crate ThumbnailUpdateUnsubscribeV3Api;

pub fn main() {

    let mut context = ThumbnailUpdateUnsubscribeV3Api::Context::default();
    let result = client.thumbnailUpdateUnsubscribe(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


TranscodingV2

getTranscodeProgress

Get Transcode Progress

TODO - Not used in Floatplane code.


/api/v2/video/transcode/progress

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/transcode/progress"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingV2Api;

import java.io.File;
import java.util.*;

public class TranscodingV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TranscodingV2Api apiInstance = new TranscodingV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getTranscodeProgress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV2Api#getTranscodeProgress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingV2Api;

public class TranscodingV2ApiExample {
    public static void main(String[] args) {
        TranscodingV2Api apiInstance = new TranscodingV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getTranscodeProgress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV2Api#getTranscodeProgress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
TranscodingV2Api *apiInstance = [[TranscodingV2Api alloc] init];

// Get Transcode Progress
[apiInstance getTranscodeProgressWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.TranscodingV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTranscodeProgress(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TranscodingV2Api();

            try {
                // Get Transcode Progress
                oas_any_type_not_mapped result = apiInstance.getTranscodeProgress();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingV2Api.getTranscodeProgress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingV2Api();

try {
    $result = $api_instance->getTranscodeProgress();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingV2Api->getTranscodeProgress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingV2Api->new();

eval {
    my $result = $api_instance->getTranscodeProgress();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingV2Api->getTranscodeProgress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingV2Api()

try:
    # Get Transcode Progress
    api_response = api_instance.get_transcode_progress()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingV2Api->getTranscodeProgress: %s\n" % e)
extern crate TranscodingV2Api;

pub fn main() {

    let mut context = TranscodingV2Api::Context::default();
    let result = client.getTranscodeProgress(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


progressSubscribe

Progress Subscribe

TODO - Not used in Floatplane code.


/api/v2/video/transcode/progress/subscribe

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/transcode/progress/subscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingV2Api;

import java.io.File;
import java.util.*;

public class TranscodingV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TranscodingV2Api apiInstance = new TranscodingV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.progressSubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV2Api#progressSubscribe");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingV2Api;

public class TranscodingV2ApiExample {
    public static void main(String[] args) {
        TranscodingV2Api apiInstance = new TranscodingV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.progressSubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV2Api#progressSubscribe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
TranscodingV2Api *apiInstance = [[TranscodingV2Api alloc] init];

// Progress Subscribe
[apiInstance progressSubscribeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.TranscodingV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.progressSubscribe(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TranscodingV2Api();

            try {
                // Progress Subscribe
                oas_any_type_not_mapped result = apiInstance.progressSubscribe();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingV2Api.progressSubscribe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingV2Api();

try {
    $result = $api_instance->progressSubscribe();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingV2Api->progressSubscribe: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingV2Api->new();

eval {
    my $result = $api_instance->progressSubscribe();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingV2Api->progressSubscribe: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingV2Api()

try:
    # Progress Subscribe
    api_response = api_instance.progress_subscribe()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingV2Api->progressSubscribe: %s\n" % e)
extern crate TranscodingV2Api;

pub fn main() {

    let mut context = TranscodingV2Api::Context::default();
    let result = client.progressSubscribe(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


progressUnsubscribe

Progress Unsubscribe

TODO - Not used in Floatplane code.


/api/v2/video/transcode/progress/unsubscribe

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/transcode/progress/unsubscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingV2Api;

import java.io.File;
import java.util.*;

public class TranscodingV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TranscodingV2Api apiInstance = new TranscodingV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.progressUnsubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV2Api#progressUnsubscribe");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingV2Api;

public class TranscodingV2ApiExample {
    public static void main(String[] args) {
        TranscodingV2Api apiInstance = new TranscodingV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.progressUnsubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV2Api#progressUnsubscribe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
TranscodingV2Api *apiInstance = [[TranscodingV2Api alloc] init];

// Progress Unsubscribe
[apiInstance progressUnsubscribeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.TranscodingV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.progressUnsubscribe(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TranscodingV2Api();

            try {
                // Progress Unsubscribe
                oas_any_type_not_mapped result = apiInstance.progressUnsubscribe();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingV2Api.progressUnsubscribe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingV2Api();

try {
    $result = $api_instance->progressUnsubscribe();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingV2Api->progressUnsubscribe: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingV2Api->new();

eval {
    my $result = $api_instance->progressUnsubscribe();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingV2Api->progressUnsubscribe: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingV2Api()

try:
    # Progress Unsubscribe
    api_response = api_instance.progress_unsubscribe()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingV2Api->progressUnsubscribe: %s\n" % e)
extern crate TranscodingV2Api;

pub fn main() {

    let mut context = TranscodingV2Api::Context::default();
    let result = client.progressUnsubscribe(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


TranscodingV3

getActiveProcesses

Get Active Processes

TODO


/api/cms/v3/processing/active

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/processing/active"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingV3Api;

import java.io.File;
import java.util.*;

public class TranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TranscodingV3Api apiInstance = new TranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getActiveProcesses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV3Api#getActiveProcesses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingV3Api;

public class TranscodingV3ApiExample {
    public static void main(String[] args) {
        TranscodingV3Api apiInstance = new TranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getActiveProcesses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV3Api#getActiveProcesses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
TranscodingV3Api *apiInstance = [[TranscodingV3Api alloc] init];

// Get Active Processes
[apiInstance getActiveProcessesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.TranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getActiveProcesses(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TranscodingV3Api();

            try {
                // Get Active Processes
                oas_any_type_not_mapped result = apiInstance.getActiveProcesses();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingV3Api.getActiveProcesses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingV3Api();

try {
    $result = $api_instance->getActiveProcesses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingV3Api->getActiveProcesses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingV3Api->new();

eval {
    my $result = $api_instance->getActiveProcesses();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingV3Api->getActiveProcesses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingV3Api()

try:
    # Get Active Processes
    api_response = api_instance.get_active_processes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingV3Api->getActiveProcesses: %s\n" % e)
extern crate TranscodingV3Api;

pub fn main() {

    let mut context = TranscodingV3Api::Context::default();
    let result = client.getActiveProcesses(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


progressSubscribeCMS

Progress Subscribe

TODO - Not used in Floatplane code.


/api/cms/v3/transcode/subscribe

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/transcode/subscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingV3Api;

import java.io.File;
import java.util.*;

public class TranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TranscodingV3Api apiInstance = new TranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.progressSubscribeCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV3Api#progressSubscribeCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingV3Api;

public class TranscodingV3ApiExample {
    public static void main(String[] args) {
        TranscodingV3Api apiInstance = new TranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.progressSubscribeCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV3Api#progressSubscribeCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
TranscodingV3Api *apiInstance = [[TranscodingV3Api alloc] init];

// Progress Subscribe
[apiInstance progressSubscribeCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.TranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.progressSubscribeCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TranscodingV3Api();

            try {
                // Progress Subscribe
                oas_any_type_not_mapped result = apiInstance.progressSubscribeCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingV3Api.progressSubscribeCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingV3Api();

try {
    $result = $api_instance->progressSubscribeCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingV3Api->progressSubscribeCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingV3Api->new();

eval {
    my $result = $api_instance->progressSubscribeCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingV3Api->progressSubscribeCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingV3Api()

try:
    # Progress Subscribe
    api_response = api_instance.progress_subscribe_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingV3Api->progressSubscribeCMS: %s\n" % e)
extern crate TranscodingV3Api;

pub fn main() {

    let mut context = TranscodingV3Api::Context::default();
    let result = client.progressSubscribeCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


progressUnsubscribeCMS

Progress Unsubscribe

TODO - Not used in Floatplane code.


/api/cms/v3/transcode/unsubscribe

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/cms/v3/transcode/unsubscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingV3Api;

import java.io.File;
import java.util.*;

public class TranscodingV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TranscodingV3Api apiInstance = new TranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.progressUnsubscribeCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV3Api#progressUnsubscribeCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingV3Api;

public class TranscodingV3ApiExample {
    public static void main(String[] args) {
        TranscodingV3Api apiInstance = new TranscodingV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.progressUnsubscribeCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingV3Api#progressUnsubscribeCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
TranscodingV3Api *apiInstance = [[TranscodingV3Api alloc] init];

// Progress Unsubscribe
[apiInstance progressUnsubscribeCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.TranscodingV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.progressUnsubscribeCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TranscodingV3Api();

            try {
                // Progress Unsubscribe
                oas_any_type_not_mapped result = apiInstance.progressUnsubscribeCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingV3Api.progressUnsubscribeCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingV3Api();

try {
    $result = $api_instance->progressUnsubscribeCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingV3Api->progressUnsubscribeCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingV3Api->new();

eval {
    my $result = $api_instance->progressUnsubscribeCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingV3Api->progressUnsubscribeCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingV3Api()

try:
    # Progress Unsubscribe
    api_response = api_instance.progress_unsubscribe_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingV3Api->progressUnsubscribeCMS: %s\n" % e)
extern crate TranscodingV3Api;

pub fn main() {

    let mut context = TranscodingV3Api::Context::default();
    let result = client.progressUnsubscribeCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


UserV2

activateBackupCode

Activate Backup Code

TODO


/api/v2/user/security/backupcode/activate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/security/backupcode/activate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.activateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#activateBackupCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.activateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#activateBackupCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Activate Backup Code
[apiInstance activateBackupCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.activateBackupCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Activate Backup Code
                oas_any_type_not_mapped result = apiInstance.activateBackupCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.activateBackupCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->activateBackupCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->activateBackupCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->activateBackupCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->activateBackupCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Activate Backup Code
    api_response = api_instance.activate_backup_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->activateBackupCode: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.activateBackupCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


activateTwoFactorAuthentication

Activate Two Factor Authentication

TODO


/api/v2/user/security/2fa/activate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/security/2fa/activate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.activateTwoFactorAuthentication();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#activateTwoFactorAuthentication");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.activateTwoFactorAuthentication();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#activateTwoFactorAuthentication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Activate Two Factor Authentication
[apiInstance activateTwoFactorAuthenticationWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.activateTwoFactorAuthentication(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Activate Two Factor Authentication
                oas_any_type_not_mapped result = apiInstance.activateTwoFactorAuthentication();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.activateTwoFactorAuthentication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->activateTwoFactorAuthentication();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->activateTwoFactorAuthentication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->activateTwoFactorAuthentication();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->activateTwoFactorAuthentication: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Activate Two Factor Authentication
    api_response = api_instance.activate_two_factor_authentication()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->activateTwoFactorAuthentication: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.activateTwoFactorAuthentication(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


changePassword

Change Password

TODO


/api/v2/user/password/change

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/password/change"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.changePassword();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#changePassword");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.changePassword();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#changePassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Change Password
[apiInstance changePasswordWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.changePassword(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Change Password
                oas_any_type_not_mapped result = apiInstance.changePassword();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.changePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->changePassword();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->changePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->changePassword();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->changePassword: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Change Password
    api_response = api_instance.change_password()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->changePassword: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.changePassword(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


completeEmailChange

Complete Email Change

TODO


/api/v2/user/email/update/complete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/email/update/complete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.completeEmailChange();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#completeEmailChange");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.completeEmailChange();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#completeEmailChange");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Complete Email Change
[apiInstance completeEmailChangeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.completeEmailChange(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Complete Email Change
                oas_any_type_not_mapped result = apiInstance.completeEmailChange();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.completeEmailChange: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->completeEmailChange();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->completeEmailChange: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->completeEmailChange();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->completeEmailChange: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Complete Email Change
    api_response = api_instance.complete_email_change()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->completeEmailChange: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.completeEmailChange(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


deactivateBackupCode

Deactivate Backup Code

TODO


/api/v2/user/security/backupcode/deactivate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/security/backupcode/deactivate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deactivateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#deactivateBackupCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deactivateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#deactivateBackupCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Deactivate Backup Code
[apiInstance deactivateBackupCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deactivateBackupCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Deactivate Backup Code
                oas_any_type_not_mapped result = apiInstance.deactivateBackupCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.deactivateBackupCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->deactivateBackupCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->deactivateBackupCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->deactivateBackupCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->deactivateBackupCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Deactivate Backup Code
    api_response = api_instance.deactivate_backup_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->deactivateBackupCode: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.deactivateBackupCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


deactivateTwoFactorAuthentication

Deactivate Two Factor Authentication

TODO


/api/v2/user/security/2fa/deactivate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/security/2fa/deactivate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deactivateTwoFactorAuthentication();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#deactivateTwoFactorAuthentication");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.deactivateTwoFactorAuthentication();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#deactivateTwoFactorAuthentication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Deactivate Two Factor Authentication
[apiInstance deactivateTwoFactorAuthenticationWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deactivateTwoFactorAuthentication(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Deactivate Two Factor Authentication
                oas_any_type_not_mapped result = apiInstance.deactivateTwoFactorAuthentication();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.deactivateTwoFactorAuthentication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->deactivateTwoFactorAuthentication();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->deactivateTwoFactorAuthentication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->deactivateTwoFactorAuthentication();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->deactivateTwoFactorAuthentication: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Deactivate Two Factor Authentication
    api_response = api_instance.deactivate_two_factor_authentication()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->deactivateTwoFactorAuthentication: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.deactivateTwoFactorAuthentication(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


generateBackupCode

Generate Backup Code

TODO


/api/v2/user/security/backupcode

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/security/backupcode"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.generateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#generateBackupCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.generateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#generateBackupCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Generate Backup Code
[apiInstance generateBackupCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateBackupCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Generate Backup Code
                oas_any_type_not_mapped result = apiInstance.generateBackupCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.generateBackupCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->generateBackupCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->generateBackupCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->generateBackupCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->generateBackupCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Generate Backup Code
    api_response = api_instance.generate_backup_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->generateBackupCode: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.generateBackupCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


generateTwoFactorSecret

Generate Two Factor Secret

TODO


/api/v2/user/security/2fa

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/security/2fa"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.generateTwoFactorSecret();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#generateTwoFactorSecret");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.generateTwoFactorSecret();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#generateTwoFactorSecret");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Generate Two Factor Secret
[apiInstance generateTwoFactorSecretWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateTwoFactorSecret(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Generate Two Factor Secret
                oas_any_type_not_mapped result = apiInstance.generateTwoFactorSecret();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.generateTwoFactorSecret: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->generateTwoFactorSecret();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->generateTwoFactorSecret: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->generateTwoFactorSecret();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->generateTwoFactorSecret: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Generate Two Factor Secret
    api_response = api_instance.generate_two_factor_secret()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->generateTwoFactorSecret: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.generateTwoFactorSecret(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getActivityFeedV2

Get Activity Feed

TODO - Not used in Floatplane code.


/api/v2/user/activity

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/activity"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getActivityFeedV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getActivityFeedV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getActivityFeedV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getActivityFeedV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Get Activity Feed
[apiInstance getActivityFeedV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getActivityFeedV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Get Activity Feed
                oas_any_type_not_mapped result = apiInstance.getActivityFeedV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.getActivityFeedV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->getActivityFeedV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->getActivityFeedV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->getActivityFeedV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->getActivityFeedV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Get Activity Feed
    api_response = api_instance.get_activity_feed_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->getActivityFeedV2: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.getActivityFeedV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getAdministrator

Get Administrator

TODO


/api/v2/user/administrator

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/administrator"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAdministrator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getAdministrator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAdministrator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getAdministrator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Get Administrator
[apiInstance getAdministratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAdministrator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Get Administrator
                oas_any_type_not_mapped result = apiInstance.getAdministrator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.getAdministrator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->getAdministrator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->getAdministrator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->getAdministrator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->getAdministrator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Get Administrator
    api_response = api_instance.get_administrator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->getAdministrator: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.getAdministrator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getExternalLinksV2

Get External Links

TODO - Not used in Floatplane code.


/api/v2/user/links

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/links"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getExternalLinksV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getExternalLinksV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getExternalLinksV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getExternalLinksV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Get External Links
[apiInstance getExternalLinksV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExternalLinksV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Get External Links
                oas_any_type_not_mapped result = apiInstance.getExternalLinksV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.getExternalLinksV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->getExternalLinksV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->getExternalLinksV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->getExternalLinksV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->getExternalLinksV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Get External Links
    api_response = api_instance.get_external_links_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->getExternalLinksV2: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.getExternalLinksV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getSecurity

Get Security

Retrieve information about the current security configuration for the user.


/api/v2/user/security

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/security"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            UserSecurityV2Response result = apiInstance.getSecurity();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getSecurity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            UserSecurityV2Response result = apiInstance.getSecurity();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getSecurity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Get Security
[apiInstance getSecurityWithCompletionHandler: 
              ^(UserSecurityV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSecurity(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Get Security
                UserSecurityV2Response result = apiInstance.getSecurity();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.getSecurity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->getSecurity();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->getSecurity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->getSecurity();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->getSecurity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Get Security
    api_response = api_instance.get_security()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->getSecurity: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.getSecurity(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserCreator

Get Creator

TODO


/api/v2/user/creator

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/creator"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserCreator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserCreator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Get Creator
[apiInstance getUserCreatorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserCreator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Get Creator
                oas_any_type_not_mapped result = apiInstance.getUserCreator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.getUserCreator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->getUserCreator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->getUserCreator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->getUserCreator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->getUserCreator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Get Creator
    api_response = api_instance.get_user_creator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->getUserCreator: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.getUserCreator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserInfo

Info

Retrieve more detailed information about one or more users from their identifiers.


/api/v2/user/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/info?id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();
        array[String] id = ; // array[String] | The GUID identifer(s) of the user(s) to be retrieved.

        try {
            UserInfoV2Response result = apiInstance.getUserInfo(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();
        array[String] id = ; // array[String] | The GUID identifer(s) of the user(s) to be retrieved.

        try {
            UserInfoV2Response result = apiInstance.getUserInfo(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];
array[String] *id = ; // The GUID identifer(s) of the user(s) to be retrieved. (default to null)

// Info
[apiInstance getUserInfoWith:id
              completionHandler: ^(UserInfoV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var id = ; // {array[String]} The GUID identifer(s) of the user(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserInfo(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();
            var id = new array[String](); // array[String] | The GUID identifer(s) of the user(s) to be retrieved. (default to null)

            try {
                // Info
                UserInfoV2Response result = apiInstance.getUserInfo(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.getUserInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();
$id = ; // array[String] | The GUID identifer(s) of the user(s) to be retrieved.

try {
    $result = $api_instance->getUserInfo($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->getUserInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();
my $id = []; # array[String] | The GUID identifer(s) of the user(s) to be retrieved.

eval {
    my $result = $api_instance->getUserInfo(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->getUserInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()
id =  # array[String] | The GUID identifer(s) of the user(s) to be retrieved. (default to null)

try:
    # Info
    api_response = api_instance.get_user_info(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->getUserInfo: %s\n" % e)
extern crate UserV2Api;

pub fn main() {
    let id = ; // array[String]

    let mut context = UserV2Api::Context::default();
    let result = client.getUserInfo(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
array[String]
The GUID identifer(s) of the user(s) to be retrieved.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserInfoByName

Get Info By Name

Retrieve more detailed information about one or more users from their usernames.


/api/v2/user/named

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/named?username="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();
        array[String] username = ; // array[String] | The username(s) of the user(s) to be retrieved.

        try {
            UserNamedV2Response result = apiInstance.getUserInfoByName(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserInfoByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();
        array[String] username = ; // array[String] | The username(s) of the user(s) to be retrieved.

        try {
            UserNamedV2Response result = apiInstance.getUserInfoByName(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserInfoByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];
array[String] *username = ; // The username(s) of the user(s) to be retrieved. (default to null)

// Get Info By Name
[apiInstance getUserInfoByNameWith:username
              completionHandler: ^(UserNamedV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var username = ; // {array[String]} The username(s) of the user(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserInfoByName(username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();
            var username = new array[String](); // array[String] | The username(s) of the user(s) to be retrieved. (default to null)

            try {
                // Get Info By Name
                UserNamedV2Response result = apiInstance.getUserInfoByName(username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.getUserInfoByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();
$username = ; // array[String] | The username(s) of the user(s) to be retrieved.

try {
    $result = $api_instance->getUserInfoByName($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->getUserInfoByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();
my $username = []; # array[String] | The username(s) of the user(s) to be retrieved.

eval {
    my $result = $api_instance->getUserInfoByName(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->getUserInfoByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()
username =  # array[String] | The username(s) of the user(s) to be retrieved. (default to null)

try:
    # Get Info By Name
    api_response = api_instance.get_user_info_by_name(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->getUserInfoByName: %s\n" % e)
extern crate UserV2Api;

pub fn main() {
    let username = ; // array[String]

    let mut context = UserV2Api::Context::default();
    let result = client.getUserInfoByName(username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
username*
array[String]
The username(s) of the user(s) to be retrieved.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserNotificationSettingsV2

Get User Notification Settings

TODO - Not used in Floatplane code.


/api/v2/user/notificationsetting

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/notificationsetting"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserNotificationSettingsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserNotificationSettingsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserNotificationSettingsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserNotificationSettingsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Get User Notification Settings
[apiInstance getUserNotificationSettingsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserNotificationSettingsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Get User Notification Settings
                oas_any_type_not_mapped result = apiInstance.getUserNotificationSettingsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.getUserNotificationSettingsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->getUserNotificationSettingsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->getUserNotificationSettingsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->getUserNotificationSettingsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->getUserNotificationSettingsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Get User Notification Settings
    api_response = api_instance.get_user_notification_settings_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->getUserNotificationSettingsV2: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.getUserNotificationSettingsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


self

Self

TODO - Not used in Floatplane code.


/api/v2/user/self

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/self"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.self();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#self");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.self();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#self");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Self
[apiInstance selfWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.self(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Self
                oas_any_type_not_mapped result = apiInstance.self();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.self: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->self();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->self: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->self();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->self: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Self
    api_response = api_instance.self()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->self: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.self(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateEmail

Update Email

TODO


/api/v2/user/email/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/email/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#updateEmail");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#updateEmail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Update Email
[apiInstance updateEmailWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateEmail(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Update Email
                oas_any_type_not_mapped result = apiInstance.updateEmail();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.updateEmail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->updateEmail();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->updateEmail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->updateEmail();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->updateEmail: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Update Email
    api_response = api_instance.update_email()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->updateEmail: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.updateEmail(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateExternalLinksV2

Update External Links

TODO - Not used in Floatplane code.


/api/v2/user/links

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/links"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateExternalLinksV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#updateExternalLinksV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateExternalLinksV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#updateExternalLinksV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Update External Links
[apiInstance updateExternalLinksV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateExternalLinksV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Update External Links
                oas_any_type_not_mapped result = apiInstance.updateExternalLinksV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.updateExternalLinksV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->updateExternalLinksV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->updateExternalLinksV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->updateExternalLinksV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->updateExternalLinksV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Update External Links
    api_response = api_instance.update_external_links_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->updateExternalLinksV2: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.updateExternalLinksV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateInfo

Update Info

TODO


/api/v2/user/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#updateInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#updateInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Update Info
[apiInstance updateInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Update Info
                oas_any_type_not_mapped result = apiInstance.updateInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.updateInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->updateInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->updateInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->updateInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->updateInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Update Info
    api_response = api_instance.update_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->updateInfo: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.updateInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateUserNotificationSettingsV2

Update User Notification Settings

TODO - Not used in Floatplane code.


/api/v2/user/notificationsetting

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/notificationsetting"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateUserNotificationSettingsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#updateUserNotificationSettingsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateUserNotificationSettingsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#updateUserNotificationSettingsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Update User Notification Settings
[apiInstance updateUserNotificationSettingsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUserNotificationSettingsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Update User Notification Settings
                oas_any_type_not_mapped result = apiInstance.updateUserNotificationSettingsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.updateUserNotificationSettingsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->updateUserNotificationSettingsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->updateUserNotificationSettingsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->updateUserNotificationSettingsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->updateUserNotificationSettingsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Update User Notification Settings
    api_response = api_instance.update_user_notification_settings_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->updateUserNotificationSettingsV2: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.updateUserNotificationSettingsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


uploadAvatar

Upload Avatar

TODO


/api/v2/user/avatar

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/avatar"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadAvatar();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#uploadAvatar");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadAvatar();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#uploadAvatar");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Upload Avatar
[apiInstance uploadAvatarWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadAvatar(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Upload Avatar
                oas_any_type_not_mapped result = apiInstance.uploadAvatar();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.uploadAvatar: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->uploadAvatar();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->uploadAvatar: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->uploadAvatar();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->uploadAvatar: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Upload Avatar
    api_response = api_instance.upload_avatar()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->uploadAvatar: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.uploadAvatar(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


userCreatorBanStatus

User Creator Ban Status

Determine whether or not the user is banned for a given creator.


/api/v2/user/ban/status

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/ban/status?creator=creator_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();
        String creator = creator_example; // String | The GUID of the creator being queried.

        try {
            'Boolean' result = apiInstance.userCreatorBanStatus(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#userCreatorBanStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();
        String creator = creator_example; // String | The GUID of the creator being queried.

        try {
            'Boolean' result = apiInstance.userCreatorBanStatus(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#userCreatorBanStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];
String *creator = creator_example; // The GUID of the creator being queried. (default to null)

// User Creator Ban Status
[apiInstance userCreatorBanStatusWith:creator
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var creator = creator_example; // {String} The GUID of the creator being queried.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userCreatorBanStatus(creator, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV2Api();
            var creator = creator_example;  // String | The GUID of the creator being queried. (default to null)

            try {
                // User Creator Ban Status
                'Boolean' result = apiInstance.userCreatorBanStatus(creator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.userCreatorBanStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();
$creator = creator_example; // String | The GUID of the creator being queried.

try {
    $result = $api_instance->userCreatorBanStatus($creator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->userCreatorBanStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();
my $creator = creator_example; # String | The GUID of the creator being queried.

eval {
    my $result = $api_instance->userCreatorBanStatus(creator => $creator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->userCreatorBanStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()
creator = creator_example # String | The GUID of the creator being queried. (default to null)

try:
    # User Creator Ban Status
    api_response = api_instance.user_creator_ban_status(creator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->userCreatorBanStatus: %s\n" % e)
extern crate UserV2Api;

pub fn main() {
    let creator = creator_example; // String

    let mut context = UserV2Api::Context::default();
    let result = client.userCreatorBanStatus(creator, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creator*
String
The GUID of the creator being queried.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


UserV3

getAchievementPerks

Get Achievement Perks

TODO - Not used in Floatplane code.


/api/v3/user/achievement/perks

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/achievement/perks"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAchievementPerks();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getAchievementPerks");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAchievementPerks();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getAchievementPerks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];

// Get Achievement Perks
[apiInstance getAchievementPerksWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAchievementPerks(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV3Api();

            try {
                // Get Achievement Perks
                oas_any_type_not_mapped result = apiInstance.getAchievementPerks();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.getAchievementPerks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();

try {
    $result = $api_instance->getAchievementPerks();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->getAchievementPerks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();

eval {
    my $result = $api_instance->getAchievementPerks();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->getAchievementPerks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()

try:
    # Get Achievement Perks
    api_response = api_instance.get_achievement_perks()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->getAchievementPerks: %s\n" % e)
extern crate UserV3Api;

pub fn main() {

    let mut context = UserV3Api::Context::default();
    let result = client.getAchievementPerks(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getActivityFeedV3

Get Activity Feed

Retrieve recent activity for a user, such as comments and other interactions they have made on posts for creators.


/api/v3/user/activity

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/activity?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();
        String id = id_example; // String | The GUID of the user being queried.

        try {
            UserActivityV3Response result = apiInstance.getActivityFeedV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getActivityFeedV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();
        String id = id_example; // String | The GUID of the user being queried.

        try {
            UserActivityV3Response result = apiInstance.getActivityFeedV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getActivityFeedV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];
String *id = id_example; // The GUID of the user being queried. (default to null)

// Get Activity Feed
[apiInstance getActivityFeedV3With:id
              completionHandler: ^(UserActivityV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var id = id_example; // {String} The GUID of the user being queried.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getActivityFeedV3(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV3Api();
            var id = id_example;  // String | The GUID of the user being queried. (default to null)

            try {
                // Get Activity Feed
                UserActivityV3Response result = apiInstance.getActivityFeedV3(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.getActivityFeedV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();
$id = id_example; // String | The GUID of the user being queried.

try {
    $result = $api_instance->getActivityFeedV3($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->getActivityFeedV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();
my $id = id_example; # String | The GUID of the user being queried.

eval {
    my $result = $api_instance->getActivityFeedV3(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->getActivityFeedV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()
id = id_example # String | The GUID of the user being queried. (default to null)

try:
    # Get Activity Feed
    api_response = api_instance.get_activity_feed_v3(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->getActivityFeedV3: %s\n" % e)
extern crate UserV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = UserV3Api::Context::default();
    let result = client.getActivityFeedV3(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the user being queried.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getExternalLinksV3

Get External Links

Retrieve configured social media links from a user's profile.


/api/v3/user/links

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/links?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();
        String id = id_example; // String | The GUID of the user being searched.

        try {
            map['String', UserLinksV3Response_value] result = apiInstance.getExternalLinksV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getExternalLinksV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();
        String id = id_example; // String | The GUID of the user being searched.

        try {
            map['String', UserLinksV3Response_value] result = apiInstance.getExternalLinksV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getExternalLinksV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];
String *id = id_example; // The GUID of the user being searched. (default to null)

// Get External Links
[apiInstance getExternalLinksV3With:id
              completionHandler: ^(map['String', UserLinksV3Response_value] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var id = id_example; // {String} The GUID of the user being searched.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExternalLinksV3(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV3Api();
            var id = id_example;  // String | The GUID of the user being searched. (default to null)

            try {
                // Get External Links
                map['String', UserLinksV3Response_value] result = apiInstance.getExternalLinksV3(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.getExternalLinksV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();
$id = id_example; // String | The GUID of the user being searched.

try {
    $result = $api_instance->getExternalLinksV3($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->getExternalLinksV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();
my $id = id_example; # String | The GUID of the user being searched.

eval {
    my $result = $api_instance->getExternalLinksV3(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->getExternalLinksV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()
id = id_example # String | The GUID of the user being searched. (default to null)

try:
    # Get External Links
    api_response = api_instance.get_external_links_v3(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->getExternalLinksV3: %s\n" % e)
extern crate UserV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = UserV3Api::Context::default();
    let result = client.getExternalLinksV3(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the user being searched.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getSelf

Get Self

Retrieve more detailed information about the user, including their name and email.


/api/v3/user/self

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/self"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();

        try {
            UserSelfV3Response result = apiInstance.getSelf();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getSelf");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();

        try {
            UserSelfV3Response result = apiInstance.getSelf();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getSelf");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];

// Get Self
[apiInstance getSelfWithCompletionHandler: 
              ^(UserSelfV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSelf(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV3Api();

            try {
                // Get Self
                UserSelfV3Response result = apiInstance.getSelf();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.getSelf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();

try {
    $result = $api_instance->getSelf();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->getSelf: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();

eval {
    my $result = $api_instance->getSelf();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->getSelf: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()

try:
    # Get Self
    api_response = api_instance.get_self()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->getSelf: %s\n" % e)
extern crate UserV3Api;

pub fn main() {

    let mut context = UserV3Api::Context::default();
    let result = client.getSelf(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserNotificationSettingsV3

Get User Notification Settings

Retrieve notification details for a user. The details are split into seperate settings for each subscribed creator.


/api/v3/user/notification/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/notification/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();

        try {
            array[UserNotificationModel] result = apiInstance.getUserNotificationSettingsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();

        try {
            array[UserNotificationModel] result = apiInstance.getUserNotificationSettingsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];

// Get User Notification Settings
[apiInstance getUserNotificationSettingsV3WithCompletionHandler: 
              ^(array[UserNotificationModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserNotificationSettingsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV3Api();

            try {
                // Get User Notification Settings
                array[UserNotificationModel] result = apiInstance.getUserNotificationSettingsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.getUserNotificationSettingsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();

try {
    $result = $api_instance->getUserNotificationSettingsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->getUserNotificationSettingsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();

eval {
    my $result = $api_instance->getUserNotificationSettingsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->getUserNotificationSettingsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()

try:
    # Get User Notification Settings
    api_response = api_instance.get_user_notification_settings_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->getUserNotificationSettingsV3: %s\n" % e)
extern crate UserV3Api;

pub fn main() {

    let mut context = UserV3Api::Context::default();
    let result = client.getUserNotificationSettingsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


scheduleDeletion

Schedule Deletion

TODO


/api/v3/user/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.scheduleDeletion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#scheduleDeletion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.scheduleDeletion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#scheduleDeletion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];

// Schedule Deletion
[apiInstance scheduleDeletionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.scheduleDeletion(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV3Api();

            try {
                // Schedule Deletion
                oas_any_type_not_mapped result = apiInstance.scheduleDeletion();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.scheduleDeletion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();

try {
    $result = $api_instance->scheduleDeletion();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->scheduleDeletion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();

eval {
    my $result = $api_instance->scheduleDeletion();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->scheduleDeletion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()

try:
    # Schedule Deletion
    api_response = api_instance.schedule_deletion()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->scheduleDeletion: %s\n" % e)
extern crate UserV3Api;

pub fn main() {

    let mut context = UserV3Api::Context::default();
    let result = client.scheduleDeletion(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


unscheduleDeletion

Unschedule Deletion

TODO


/api/v3/user/undelete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/undelete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unscheduleDeletion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#unscheduleDeletion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unscheduleDeletion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#unscheduleDeletion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];

// Unschedule Deletion
[apiInstance unscheduleDeletionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unscheduleDeletion(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV3Api();

            try {
                // Unschedule Deletion
                oas_any_type_not_mapped result = apiInstance.unscheduleDeletion();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.unscheduleDeletion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();

try {
    $result = $api_instance->unscheduleDeletion();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->unscheduleDeletion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();

eval {
    my $result = $api_instance->unscheduleDeletion();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->unscheduleDeletion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()

try:
    # Unschedule Deletion
    api_response = api_instance.unschedule_deletion()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->unscheduleDeletion: %s\n" % e)
extern crate UserV3Api;

pub fn main() {

    let mut context = UserV3Api::Context::default();
    let result = client.unscheduleDeletion(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateExternalLinksV3

Update External Links

TODO


/api/v3/user/links

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/links"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateExternalLinksV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#updateExternalLinksV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateExternalLinksV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#updateExternalLinksV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];

// Update External Links
[apiInstance updateExternalLinksV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateExternalLinksV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV3Api();

            try {
                // Update External Links
                oas_any_type_not_mapped result = apiInstance.updateExternalLinksV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.updateExternalLinksV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();

try {
    $result = $api_instance->updateExternalLinksV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->updateExternalLinksV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();

eval {
    my $result = $api_instance->updateExternalLinksV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->updateExternalLinksV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()

try:
    # Update External Links
    api_response = api_instance.update_external_links_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->updateExternalLinksV3: %s\n" % e)
extern crate UserV3Api;

pub fn main() {

    let mut context = UserV3Api::Context::default();
    let result = client.updateExternalLinksV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateUserNotificationSettingsV3

Update User Notification Settings

Enable or disable email or push notifications for a specific creator.


/api/v3/user/notification/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/user/notification/update" \
 -d '{
  "newValue" : true,
  "creator" : "creator",
  "property" : "contentEmail"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();
        UserNotificationUpdateV3PostRequest userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest | 

        try {
            'Boolean' result = apiInstance.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#updateUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();
        UserNotificationUpdateV3PostRequest userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest | 

        try {
            'Boolean' result = apiInstance.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#updateUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];
UserNotificationUpdateV3PostRequest *userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // 

// Update User Notification Settings
[apiInstance updateUserNotificationSettingsV3With:userNotificationUpdateV3PostRequest
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // {UserNotificationUpdateV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserV3Api();
            var userNotificationUpdateV3PostRequest = new UserNotificationUpdateV3PostRequest(); // UserNotificationUpdateV3PostRequest | 

            try {
                // Update User Notification Settings
                'Boolean' result = apiInstance.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.updateUserNotificationSettingsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();
$userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest | 

try {
    $result = $api_instance->updateUserNotificationSettingsV3($userNotificationUpdateV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->updateUserNotificationSettingsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();
my $userNotificationUpdateV3PostRequest = WWW::OPenAPIClient::Object::UserNotificationUpdateV3PostRequest->new(); # UserNotificationUpdateV3PostRequest | 

eval {
    my $result = $api_instance->updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest => $userNotificationUpdateV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->updateUserNotificationSettingsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()
userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false} # UserNotificationUpdateV3PostRequest | 

try:
    # Update User Notification Settings
    api_response = api_instance.update_user_notification_settings_v3(userNotificationUpdateV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->updateUserNotificationSettingsV3: %s\n" % e)
extern crate UserV3Api;

pub fn main() {
    let userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest

    let mut context = UserV3Api::Context::default();
    let result = client.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userNotificationUpdateV3PostRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


VideoCommentInteractionsV2

clearInteraction

Clear Interaction

TODO - Not used in Floatplane code.


/api/v2/video/comment/interaction/clear

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/comment/interaction/clear"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoCommentInteractionsV2Api;

import java.io.File;
import java.util.*;

public class VideoCommentInteractionsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoCommentInteractionsV2Api apiInstance = new VideoCommentInteractionsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.clearInteraction();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentInteractionsV2Api#clearInteraction");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoCommentInteractionsV2Api;

public class VideoCommentInteractionsV2ApiExample {
    public static void main(String[] args) {
        VideoCommentInteractionsV2Api apiInstance = new VideoCommentInteractionsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.clearInteraction();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentInteractionsV2Api#clearInteraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoCommentInteractionsV2Api *apiInstance = [[VideoCommentInteractionsV2Api alloc] init];

// Clear Interaction
[apiInstance clearInteractionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoCommentInteractionsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clearInteraction(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoCommentInteractionsV2Api();

            try {
                // Clear Interaction
                oas_any_type_not_mapped result = apiInstance.clearInteraction();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoCommentInteractionsV2Api.clearInteraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoCommentInteractionsV2Api();

try {
    $result = $api_instance->clearInteraction();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoCommentInteractionsV2Api->clearInteraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoCommentInteractionsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoCommentInteractionsV2Api->new();

eval {
    my $result = $api_instance->clearInteraction();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoCommentInteractionsV2Api->clearInteraction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoCommentInteractionsV2Api()

try:
    # Clear Interaction
    api_response = api_instance.clear_interaction()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoCommentInteractionsV2Api->clearInteraction: %s\n" % e)
extern crate VideoCommentInteractionsV2Api;

pub fn main() {

    let mut context = VideoCommentInteractionsV2Api::Context::default();
    let result = client.clearInteraction(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


setInteraction

Set Interaction

TODO - Not used in Floatplane code.


/api/v2/video/comment/interaction/set

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/comment/interaction/set"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoCommentInteractionsV2Api;

import java.io.File;
import java.util.*;

public class VideoCommentInteractionsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoCommentInteractionsV2Api apiInstance = new VideoCommentInteractionsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.setInteraction();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentInteractionsV2Api#setInteraction");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoCommentInteractionsV2Api;

public class VideoCommentInteractionsV2ApiExample {
    public static void main(String[] args) {
        VideoCommentInteractionsV2Api apiInstance = new VideoCommentInteractionsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.setInteraction();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentInteractionsV2Api#setInteraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoCommentInteractionsV2Api *apiInstance = [[VideoCommentInteractionsV2Api alloc] init];

// Set Interaction
[apiInstance setInteractionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoCommentInteractionsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setInteraction(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoCommentInteractionsV2Api();

            try {
                // Set Interaction
                oas_any_type_not_mapped result = apiInstance.setInteraction();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoCommentInteractionsV2Api.setInteraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoCommentInteractionsV2Api();

try {
    $result = $api_instance->setInteraction();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoCommentInteractionsV2Api->setInteraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoCommentInteractionsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoCommentInteractionsV2Api->new();

eval {
    my $result = $api_instance->setInteraction();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoCommentInteractionsV2Api->setInteraction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoCommentInteractionsV2Api()

try:
    # Set Interaction
    api_response = api_instance.set_interaction()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoCommentInteractionsV2Api->setInteraction: %s\n" % e)
extern crate VideoCommentInteractionsV2Api;

pub fn main() {

    let mut context = VideoCommentInteractionsV2Api::Context::default();
    let result = client.setInteraction(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


VideoCommentsV2

addVideoComment

Add Video Comment

TODO - Not used in Floatplane code.


/api/v2/video/comment

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/comment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoCommentsV2Api;

import java.io.File;
import java.util.*;

public class VideoCommentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoCommentsV2Api apiInstance = new VideoCommentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addVideoComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsV2Api#addVideoComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoCommentsV2Api;

public class VideoCommentsV2ApiExample {
    public static void main(String[] args) {
        VideoCommentsV2Api apiInstance = new VideoCommentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.addVideoComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsV2Api#addVideoComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoCommentsV2Api *apiInstance = [[VideoCommentsV2Api alloc] init];

// Add Video Comment
[apiInstance addVideoCommentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoCommentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addVideoComment(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoCommentsV2Api();

            try {
                // Add Video Comment
                oas_any_type_not_mapped result = apiInstance.addVideoComment();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoCommentsV2Api.addVideoComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoCommentsV2Api();

try {
    $result = $api_instance->addVideoComment();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoCommentsV2Api->addVideoComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoCommentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoCommentsV2Api->new();

eval {
    my $result = $api_instance->addVideoComment();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoCommentsV2Api->addVideoComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoCommentsV2Api()

try:
    # Add Video Comment
    api_response = api_instance.add_video_comment()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoCommentsV2Api->addVideoComment: %s\n" % e)
extern crate VideoCommentsV2Api;

pub fn main() {

    let mut context = VideoCommentsV2Api::Context::default();
    let result = client.addVideoComment(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getVideoCommentReplies

Get Video Comment Replies

TODO - Not used in Floatplane code.


/api/v2/video/comment/replies

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/comment/replies"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoCommentsV2Api;

import java.io.File;
import java.util.*;

public class VideoCommentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoCommentsV2Api apiInstance = new VideoCommentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getVideoCommentReplies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsV2Api#getVideoCommentReplies");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoCommentsV2Api;

public class VideoCommentsV2ApiExample {
    public static void main(String[] args) {
        VideoCommentsV2Api apiInstance = new VideoCommentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getVideoCommentReplies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsV2Api#getVideoCommentReplies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoCommentsV2Api *apiInstance = [[VideoCommentsV2Api alloc] init];

// Get Video Comment Replies
[apiInstance getVideoCommentRepliesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoCommentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoCommentReplies(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoCommentsV2Api();

            try {
                // Get Video Comment Replies
                oas_any_type_not_mapped result = apiInstance.getVideoCommentReplies();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoCommentsV2Api.getVideoCommentReplies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoCommentsV2Api();

try {
    $result = $api_instance->getVideoCommentReplies();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoCommentsV2Api->getVideoCommentReplies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoCommentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoCommentsV2Api->new();

eval {
    my $result = $api_instance->getVideoCommentReplies();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoCommentsV2Api->getVideoCommentReplies: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoCommentsV2Api()

try:
    # Get Video Comment Replies
    api_response = api_instance.get_video_comment_replies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoCommentsV2Api->getVideoCommentReplies: %s\n" % e)
extern crate VideoCommentsV2Api;

pub fn main() {

    let mut context = VideoCommentsV2Api::Context::default();
    let result = client.getVideoCommentReplies(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getVideoComments

Get Video Comments

TODO - Not used in Floatplane code.


/api/v2/video/comments

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/comments"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoCommentsV2Api;

import java.io.File;
import java.util.*;

public class VideoCommentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoCommentsV2Api apiInstance = new VideoCommentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getVideoComments();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsV2Api#getVideoComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoCommentsV2Api;

public class VideoCommentsV2ApiExample {
    public static void main(String[] args) {
        VideoCommentsV2Api apiInstance = new VideoCommentsV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getVideoComments();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsV2Api#getVideoComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoCommentsV2Api *apiInstance = [[VideoCommentsV2Api alloc] init];

// Get Video Comments
[apiInstance getVideoCommentsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoCommentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoComments(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoCommentsV2Api();

            try {
                // Get Video Comments
                oas_any_type_not_mapped result = apiInstance.getVideoComments();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoCommentsV2Api.getVideoComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoCommentsV2Api();

try {
    $result = $api_instance->getVideoComments();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoCommentsV2Api->getVideoComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoCommentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoCommentsV2Api->new();

eval {
    my $result = $api_instance->getVideoComments();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoCommentsV2Api->getVideoComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoCommentsV2Api()

try:
    # Get Video Comments
    api_response = api_instance.get_video_comments()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoCommentsV2Api->getVideoComments: %s\n" % e)
extern crate VideoCommentsV2Api;

pub fn main() {

    let mut context = VideoCommentsV2Api::Context::default();
    let result = client.getVideoComments(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


VideoUploadV2

abortMultipartUploadV2

Abort Multipart Upload

TODO - Not used in Floatplane code.


/api/v2/video/upload/s3/multipart/abort

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/upload/s3/multipart/abort"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadV2Api;

import java.io.File;
import java.util.*;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#abortMultipartUploadV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadV2Api;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#abortMultipartUploadV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoUploadV2Api *apiInstance = [[VideoUploadV2Api alloc] init];

// Abort Multipart Upload
[apiInstance abortMultipartUploadV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoUploadV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.abortMultipartUploadV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoUploadV2Api();

            try {
                // Abort Multipart Upload
                oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadV2Api.abortMultipartUploadV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadV2Api();

try {
    $result = $api_instance->abortMultipartUploadV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadV2Api->abortMultipartUploadV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadV2Api->new();

eval {
    my $result = $api_instance->abortMultipartUploadV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadV2Api->abortMultipartUploadV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadV2Api()

try:
    # Abort Multipart Upload
    api_response = api_instance.abort_multipart_upload_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadV2Api->abortMultipartUploadV2: %s\n" % e)
extern crate VideoUploadV2Api;

pub fn main() {

    let mut context = VideoUploadV2Api::Context::default();
    let result = client.abortMultipartUploadV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


completeMultipartUploadVideo

Complete Multipart Upload

TODO - Not used in Floatplane code.


/api/v2/video/upload/s3/multipart/complete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/upload/s3/multipart/complete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadV2Api;

import java.io.File;
import java.util.*;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.completeMultipartUploadVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#completeMultipartUploadVideo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadV2Api;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.completeMultipartUploadVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#completeMultipartUploadVideo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoUploadV2Api *apiInstance = [[VideoUploadV2Api alloc] init];

// Complete Multipart Upload
[apiInstance completeMultipartUploadVideoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoUploadV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.completeMultipartUploadVideo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoUploadV2Api();

            try {
                // Complete Multipart Upload
                oas_any_type_not_mapped result = apiInstance.completeMultipartUploadVideo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadV2Api.completeMultipartUploadVideo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadV2Api();

try {
    $result = $api_instance->completeMultipartUploadVideo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadV2Api->completeMultipartUploadVideo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadV2Api->new();

eval {
    my $result = $api_instance->completeMultipartUploadVideo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadV2Api->completeMultipartUploadVideo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadV2Api()

try:
    # Complete Multipart Upload
    api_response = api_instance.complete_multipart_upload_video()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadV2Api->completeMultipartUploadVideo: %s\n" % e)
extern crate VideoUploadV2Api;

pub fn main() {

    let mut context = VideoUploadV2Api::Context::default();
    let result = client.completeMultipartUploadVideo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


createMultipartUploadV2

Create Multipart Upload

TODO - Not used in Floatplane code.


/api/v2/video/upload/s3/multipart

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/upload/s3/multipart"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadV2Api;

import java.io.File;
import java.util.*;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createMultipartUploadV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#createMultipartUploadV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadV2Api;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.createMultipartUploadV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#createMultipartUploadV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoUploadV2Api *apiInstance = [[VideoUploadV2Api alloc] init];

// Create Multipart Upload
[apiInstance createMultipartUploadV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoUploadV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMultipartUploadV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoUploadV2Api();

            try {
                // Create Multipart Upload
                oas_any_type_not_mapped result = apiInstance.createMultipartUploadV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadV2Api.createMultipartUploadV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadV2Api();

try {
    $result = $api_instance->createMultipartUploadV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadV2Api->createMultipartUploadV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadV2Api->new();

eval {
    my $result = $api_instance->createMultipartUploadV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadV2Api->createMultipartUploadV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadV2Api()

try:
    # Create Multipart Upload
    api_response = api_instance.create_multipart_upload_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadV2Api->createMultipartUploadV2: %s\n" % e)
extern crate VideoUploadV2Api;

pub fn main() {

    let mut context = VideoUploadV2Api::Context::default();
    let result = client.createMultipartUploadV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUploadedPartsV2

Get Uploaded Parts

TODO - Not used in Floatplane code.


/api/v2/video/upload/s3/multipart

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/upload/s3/multipart"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadV2Api;

import java.io.File;
import java.util.*;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUploadedPartsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#getUploadedPartsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadV2Api;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUploadedPartsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#getUploadedPartsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoUploadV2Api *apiInstance = [[VideoUploadV2Api alloc] init];

// Get Uploaded Parts
[apiInstance getUploadedPartsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoUploadV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUploadedPartsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoUploadV2Api();

            try {
                // Get Uploaded Parts
                oas_any_type_not_mapped result = apiInstance.getUploadedPartsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadV2Api.getUploadedPartsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadV2Api();

try {
    $result = $api_instance->getUploadedPartsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadV2Api->getUploadedPartsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadV2Api->new();

eval {
    my $result = $api_instance->getUploadedPartsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadV2Api->getUploadedPartsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadV2Api()

try:
    # Get Uploaded Parts
    api_response = api_instance.get_uploaded_parts_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadV2Api->getUploadedPartsV2: %s\n" % e)
extern crate VideoUploadV2Api;

pub fn main() {

    let mut context = VideoUploadV2Api::Context::default();
    let result = client.getUploadedPartsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


signPartUploadVideo

Sign Part Upload

TODO - Not used in Floatplane code.


/api/v2/video/upload/s3/multipart/sign

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/upload/s3/multipart/sign"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadV2Api;

import java.io.File;
import java.util.*;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.signPartUploadVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#signPartUploadVideo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadV2Api;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.signPartUploadVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#signPartUploadVideo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoUploadV2Api *apiInstance = [[VideoUploadV2Api alloc] init];

// Sign Part Upload
[apiInstance signPartUploadVideoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoUploadV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.signPartUploadVideo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoUploadV2Api();

            try {
                // Sign Part Upload
                oas_any_type_not_mapped result = apiInstance.signPartUploadVideo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadV2Api.signPartUploadVideo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadV2Api();

try {
    $result = $api_instance->signPartUploadVideo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadV2Api->signPartUploadVideo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadV2Api->new();

eval {
    my $result = $api_instance->signPartUploadVideo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadV2Api->signPartUploadVideo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadV2Api()

try:
    # Sign Part Upload
    api_response = api_instance.sign_part_upload_video()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadV2Api->signPartUploadVideo: %s\n" % e)
extern crate VideoUploadV2Api;

pub fn main() {

    let mut context = VideoUploadV2Api::Context::default();
    let result = client.signPartUploadVideo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


uploadThumbnailV2

Upload Thumbnail

TODO - Not used in Floatplane code.


/api/v2/video/upload/thumbnail

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/upload/thumbnail"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadV2Api;

import java.io.File;
import java.util.*;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadThumbnailV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#uploadThumbnailV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadV2Api;

public class VideoUploadV2ApiExample {
    public static void main(String[] args) {
        VideoUploadV2Api apiInstance = new VideoUploadV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.uploadThumbnailV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadV2Api#uploadThumbnailV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoUploadV2Api *apiInstance = [[VideoUploadV2Api alloc] init];

// Upload Thumbnail
[apiInstance uploadThumbnailV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoUploadV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadThumbnailV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoUploadV2Api();

            try {
                // Upload Thumbnail
                oas_any_type_not_mapped result = apiInstance.uploadThumbnailV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadV2Api.uploadThumbnailV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadV2Api();

try {
    $result = $api_instance->uploadThumbnailV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadV2Api->uploadThumbnailV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadV2Api->new();

eval {
    my $result = $api_instance->uploadThumbnailV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadV2Api->uploadThumbnailV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadV2Api()

try:
    # Upload Thumbnail
    api_response = api_instance.upload_thumbnail_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadV2Api->uploadThumbnailV2: %s\n" % e)
extern crate VideoUploadV2Api;

pub fn main() {

    let mut context = VideoUploadV2Api::Context::default();
    let result = client.uploadThumbnailV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


VideoV2

getDashClearKeys

Get Dash Clear Keys

TODO - Not used in Floatplane code.


/api/v2/video/dash/watchkey

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/dash/watchkey"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoV2Api;

import java.io.File;
import java.util.*;

public class VideoV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoV2Api apiInstance = new VideoV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getDashClearKeys();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoV2Api#getDashClearKeys");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoV2Api;

public class VideoV2ApiExample {
    public static void main(String[] args) {
        VideoV2Api apiInstance = new VideoV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getDashClearKeys();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoV2Api#getDashClearKeys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoV2Api *apiInstance = [[VideoV2Api alloc] init];

// Get Dash Clear Keys
[apiInstance getDashClearKeysWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashClearKeys(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoV2Api();

            try {
                // Get Dash Clear Keys
                oas_any_type_not_mapped result = apiInstance.getDashClearKeys();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoV2Api.getDashClearKeys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoV2Api();

try {
    $result = $api_instance->getDashClearKeys();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoV2Api->getDashClearKeys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoV2Api->new();

eval {
    my $result = $api_instance->getDashClearKeys();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoV2Api->getDashClearKeys: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoV2Api()

try:
    # Get Dash Clear Keys
    api_response = api_instance.get_dash_clear_keys()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoV2Api->getDashClearKeys: %s\n" % e)
extern crate VideoV2Api;

pub fn main() {

    let mut context = VideoV2Api::Context::default();
    let result = client.getDashClearKeys(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getDashClearKeysOverPost

Get Dash Clear Keys Over Post

TODO - Not used in Floatplane code.


/api/v2/video/dash/watchkey

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/dash/watchkey"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoV2Api;

import java.io.File;
import java.util.*;

public class VideoV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoV2Api apiInstance = new VideoV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getDashClearKeysOverPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoV2Api#getDashClearKeysOverPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoV2Api;

public class VideoV2ApiExample {
    public static void main(String[] args) {
        VideoV2Api apiInstance = new VideoV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getDashClearKeysOverPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoV2Api#getDashClearKeysOverPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoV2Api *apiInstance = [[VideoV2Api alloc] init];

// Get Dash Clear Keys Over Post
[apiInstance getDashClearKeysOverPostWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashClearKeysOverPost(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoV2Api();

            try {
                // Get Dash Clear Keys Over Post
                oas_any_type_not_mapped result = apiInstance.getDashClearKeysOverPost();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoV2Api.getDashClearKeysOverPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoV2Api();

try {
    $result = $api_instance->getDashClearKeysOverPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoV2Api->getDashClearKeysOverPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoV2Api->new();

eval {
    my $result = $api_instance->getDashClearKeysOverPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoV2Api->getDashClearKeysOverPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoV2Api()

try:
    # Get Dash Clear Keys Over Post
    api_response = api_instance.get_dash_clear_keys_over_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoV2Api->getDashClearKeysOverPost: %s\n" % e)
extern crate VideoV2Api;

pub fn main() {

    let mut context = VideoV2Api::Context::default();
    let result = client.getDashClearKeysOverPost(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getDashSignedChunkUrl

Get Dash Signed Chunk Url

TODO - Not used in Floatplane code.


/api/v2/video/dash/chunk/signed

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/video/dash/chunk/signed"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoV2Api;

import java.io.File;
import java.util.*;

public class VideoV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VideoV2Api apiInstance = new VideoV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getDashSignedChunkUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoV2Api#getDashSignedChunkUrl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoV2Api;

public class VideoV2ApiExample {
    public static void main(String[] args) {
        VideoV2Api apiInstance = new VideoV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getDashSignedChunkUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoV2Api#getDashSignedChunkUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VideoV2Api *apiInstance = [[VideoV2Api alloc] init];

// Get Dash Signed Chunk Url
[apiInstance getDashSignedChunkUrlWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VideoV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashSignedChunkUrl(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VideoV2Api();

            try {
                // Get Dash Signed Chunk Url
                oas_any_type_not_mapped result = apiInstance.getDashSignedChunkUrl();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoV2Api.getDashSignedChunkUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoV2Api();

try {
    $result = $api_instance->getDashSignedChunkUrl();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoV2Api->getDashSignedChunkUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoV2Api->new();

eval {
    my $result = $api_instance->getDashSignedChunkUrl();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoV2Api->getDashSignedChunkUrl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoV2Api()

try:
    # Get Dash Signed Chunk Url
    api_response = api_instance.get_dash_signed_chunk_url()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoV2Api->getDashSignedChunkUrl: %s\n" % e)
extern crate VideoV2Api;

pub fn main() {

    let mut context = VideoV2Api::Context::default();
    let result = client.getDashSignedChunkUrl(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


VpnV3

downloadUserProfile

Download User Profile

TODO


/api/v3/experiments/vpn/profile/download

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/experiments/vpn/profile/download"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VpnV3Api;

import java.io.File;
import java.util.*;

public class VpnV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VpnV3Api apiInstance = new VpnV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.downloadUserProfile();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnV3Api#downloadUserProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VpnV3Api;

public class VpnV3ApiExample {
    public static void main(String[] args) {
        VpnV3Api apiInstance = new VpnV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.downloadUserProfile();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnV3Api#downloadUserProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VpnV3Api *apiInstance = [[VpnV3Api alloc] init];

// Download User Profile
[apiInstance downloadUserProfileWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VpnV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadUserProfile(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VpnV3Api();

            try {
                // Download User Profile
                oas_any_type_not_mapped result = apiInstance.downloadUserProfile();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VpnV3Api.downloadUserProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VpnV3Api();

try {
    $result = $api_instance->downloadUserProfile();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VpnV3Api->downloadUserProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VpnV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VpnV3Api->new();

eval {
    my $result = $api_instance->downloadUserProfile();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VpnV3Api->downloadUserProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VpnV3Api()

try:
    # Download User Profile
    api_response = api_instance.download_user_profile()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VpnV3Api->downloadUserProfile: %s\n" % e)
extern crate VpnV3Api;

pub fn main() {

    let mut context = VpnV3Api::Context::default();
    let result = client.downloadUserProfile(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getEnabledState

Get Enabled State

TODO


/api/v3/experiments/vpn/enabled

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/experiments/vpn/enabled"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VpnV3Api;

import java.io.File;
import java.util.*;

public class VpnV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VpnV3Api apiInstance = new VpnV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getEnabledState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnV3Api#getEnabledState");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VpnV3Api;

public class VpnV3ApiExample {
    public static void main(String[] args) {
        VpnV3Api apiInstance = new VpnV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getEnabledState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnV3Api#getEnabledState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VpnV3Api *apiInstance = [[VpnV3Api alloc] init];

// Get Enabled State
[apiInstance getEnabledStateWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VpnV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEnabledState(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VpnV3Api();

            try {
                // Get Enabled State
                oas_any_type_not_mapped result = apiInstance.getEnabledState();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VpnV3Api.getEnabledState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VpnV3Api();

try {
    $result = $api_instance->getEnabledState();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VpnV3Api->getEnabledState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VpnV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VpnV3Api->new();

eval {
    my $result = $api_instance->getEnabledState();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VpnV3Api->getEnabledState: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VpnV3Api()

try:
    # Get Enabled State
    api_response = api_instance.get_enabled_state()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VpnV3Api->getEnabledState: %s\n" % e)
extern crate VpnV3Api;

pub fn main() {

    let mut context = VpnV3Api::Context::default();
    let result = client.getEnabledState(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getServerList

Get Server List

TODO


/api/v3/experiments/vpn/server/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/experiments/vpn/server/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VpnV3Api;

import java.io.File;
import java.util.*;

public class VpnV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VpnV3Api apiInstance = new VpnV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getServerList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnV3Api#getServerList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VpnV3Api;

public class VpnV3ApiExample {
    public static void main(String[] args) {
        VpnV3Api apiInstance = new VpnV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getServerList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnV3Api#getServerList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VpnV3Api *apiInstance = [[VpnV3Api alloc] init];

// Get Server List
[apiInstance getServerListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VpnV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getServerList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VpnV3Api();

            try {
                // Get Server List
                oas_any_type_not_mapped result = apiInstance.getServerList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VpnV3Api.getServerList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VpnV3Api();

try {
    $result = $api_instance->getServerList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VpnV3Api->getServerList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VpnV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VpnV3Api->new();

eval {
    my $result = $api_instance->getServerList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VpnV3Api->getServerList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VpnV3Api()

try:
    # Get Server List
    api_response = api_instance.get_server_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VpnV3Api->getServerList: %s\n" % e)
extern crate VpnV3Api;

pub fn main() {

    let mut context = VpnV3Api::Context::default();
    let result = client.getServerList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserProfileLinksEphemeral

Get User Profile Links Ephemeral

TODO - Not used in Floatplane code yet.


/api/v3/experiments/vpn/profile/ephemeral

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/experiments/vpn/profile/ephemeral"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VpnV3Api;

import java.io.File;
import java.util.*;

public class VpnV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VpnV3Api apiInstance = new VpnV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserProfileLinksEphemeral();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnV3Api#getUserProfileLinksEphemeral");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VpnV3Api;

public class VpnV3ApiExample {
    public static void main(String[] args) {
        VpnV3Api apiInstance = new VpnV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getUserProfileLinksEphemeral();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnV3Api#getUserProfileLinksEphemeral");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VpnV3Api *apiInstance = [[VpnV3Api alloc] init];

// Get User Profile Links Ephemeral
[apiInstance getUserProfileLinksEphemeralWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VpnV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserProfileLinksEphemeral(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VpnV3Api();

            try {
                // Get User Profile Links Ephemeral
                oas_any_type_not_mapped result = apiInstance.getUserProfileLinksEphemeral();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VpnV3Api.getUserProfileLinksEphemeral: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VpnV3Api();

try {
    $result = $api_instance->getUserProfileLinksEphemeral();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VpnV3Api->getUserProfileLinksEphemeral: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VpnV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VpnV3Api->new();

eval {
    my $result = $api_instance->getUserProfileLinksEphemeral();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VpnV3Api->getUserProfileLinksEphemeral: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VpnV3Api()

try:
    # Get User Profile Links Ephemeral
    api_response = api_instance.get_user_profile_links_ephemeral()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VpnV3Api->getUserProfileLinksEphemeral: %s\n" % e)
extern crate VpnV3Api;

pub fn main() {

    let mut context = VpnV3Api::Context::default();
    let result = client.getUserProfileLinksEphemeral(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateEnabledState

Update Enabled State

TODO


/api/v3/experiments/vpn/enabled

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/experiments/vpn/enabled"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VpnV3Api;

import java.io.File;
import java.util.*;

public class VpnV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VpnV3Api apiInstance = new VpnV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateEnabledState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnV3Api#updateEnabledState");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VpnV3Api;

public class VpnV3ApiExample {
    public static void main(String[] args) {
        VpnV3Api apiInstance = new VpnV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.updateEnabledState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnV3Api#updateEnabledState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
VpnV3Api *apiInstance = [[VpnV3Api alloc] init];

// Update Enabled State
[apiInstance updateEnabledStateWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.VpnV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateEnabledState(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new VpnV3Api();

            try {
                // Update Enabled State
                oas_any_type_not_mapped result = apiInstance.updateEnabledState();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VpnV3Api.updateEnabledState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VpnV3Api();

try {
    $result = $api_instance->updateEnabledState();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VpnV3Api->updateEnabledState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VpnV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VpnV3Api->new();

eval {
    my $result = $api_instance->updateEnabledState();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VpnV3Api->updateEnabledState: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VpnV3Api()

try:
    # Update Enabled State
    api_response = api_instance.update_enabled_state()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VpnV3Api->updateEnabledState: %s\n" % e)
extern crate VpnV3Api;

pub fn main() {

    let mut context = VpnV3Api::Context::default();
    let result = client.updateEnabledState(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


WebNotificationV2

getAppInfoV2

Get App Info

TODO - Not used in Floatplane code.


/api/v2/push/web/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/push/web/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationV2Api;

import java.io.File;
import java.util.*;

public class WebNotificationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebNotificationV2Api apiInstance = new WebNotificationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAppInfoV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV2Api#getAppInfoV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationV2Api;

public class WebNotificationV2ApiExample {
    public static void main(String[] args) {
        WebNotificationV2Api apiInstance = new WebNotificationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAppInfoV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV2Api#getAppInfoV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
WebNotificationV2Api *apiInstance = [[WebNotificationV2Api alloc] init];

// Get App Info
[apiInstance getAppInfoV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.WebNotificationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAppInfoV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new WebNotificationV2Api();

            try {
                // Get App Info
                oas_any_type_not_mapped result = apiInstance.getAppInfoV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationV2Api.getAppInfoV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationV2Api();

try {
    $result = $api_instance->getAppInfoV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationV2Api->getAppInfoV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationV2Api->new();

eval {
    my $result = $api_instance->getAppInfoV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationV2Api->getAppInfoV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationV2Api()

try:
    # Get App Info
    api_response = api_instance.get_app_info_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationV2Api->getAppInfoV2: %s\n" % e)
extern crate WebNotificationV2Api;

pub fn main() {

    let mut context = WebNotificationV2Api::Context::default();
    let result = client.getAppInfoV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getTokenInfo

Get Token Info

TODO - Not used in Floatplane code.


/api/v2/push/web/tokenInfo

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/push/web/tokenInfo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationV2Api;

import java.io.File;
import java.util.*;

public class WebNotificationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebNotificationV2Api apiInstance = new WebNotificationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getTokenInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV2Api#getTokenInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationV2Api;

public class WebNotificationV2ApiExample {
    public static void main(String[] args) {
        WebNotificationV2Api apiInstance = new WebNotificationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getTokenInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV2Api#getTokenInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
WebNotificationV2Api *apiInstance = [[WebNotificationV2Api alloc] init];

// Get Token Info
[apiInstance getTokenInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.WebNotificationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTokenInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new WebNotificationV2Api();

            try {
                // Get Token Info
                oas_any_type_not_mapped result = apiInstance.getTokenInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationV2Api.getTokenInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationV2Api();

try {
    $result = $api_instance->getTokenInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationV2Api->getTokenInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationV2Api->new();

eval {
    my $result = $api_instance->getTokenInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationV2Api->getTokenInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationV2Api()

try:
    # Get Token Info
    api_response = api_instance.get_token_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationV2Api->getTokenInfo: %s\n" % e)
extern crate WebNotificationV2Api;

pub fn main() {

    let mut context = WebNotificationV2Api::Context::default();
    let result = client.getTokenInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


registerV2

Register

TODO - Not used in Floatplane code.


/api/v2/push/web/register

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/push/web/register"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationV2Api;

import java.io.File;
import java.util.*;

public class WebNotificationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebNotificationV2Api apiInstance = new WebNotificationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.registerV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV2Api#registerV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationV2Api;

public class WebNotificationV2ApiExample {
    public static void main(String[] args) {
        WebNotificationV2Api apiInstance = new WebNotificationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.registerV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV2Api#registerV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
WebNotificationV2Api *apiInstance = [[WebNotificationV2Api alloc] init];

// Register
[apiInstance registerV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.WebNotificationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new WebNotificationV2Api();

            try {
                // Register
                oas_any_type_not_mapped result = apiInstance.registerV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationV2Api.registerV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationV2Api();

try {
    $result = $api_instance->registerV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationV2Api->registerV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationV2Api->new();

eval {
    my $result = $api_instance->registerV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationV2Api->registerV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationV2Api()

try:
    # Register
    api_response = api_instance.register_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationV2Api->registerV2: %s\n" % e)
extern crate WebNotificationV2Api;

pub fn main() {

    let mut context = WebNotificationV2Api::Context::default();
    let result = client.registerV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


unregisterV2

Unregister

TODO - Not used in Floatplane code.


/api/v2/push/web/revoke

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/push/web/revoke"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationV2Api;

import java.io.File;
import java.util.*;

public class WebNotificationV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebNotificationV2Api apiInstance = new WebNotificationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unregisterV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV2Api#unregisterV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationV2Api;

public class WebNotificationV2ApiExample {
    public static void main(String[] args) {
        WebNotificationV2Api apiInstance = new WebNotificationV2Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unregisterV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV2Api#unregisterV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
WebNotificationV2Api *apiInstance = [[WebNotificationV2Api alloc] init];

// Unregister
[apiInstance unregisterV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.WebNotificationV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unregisterV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new WebNotificationV2Api();

            try {
                // Unregister
                oas_any_type_not_mapped result = apiInstance.unregisterV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationV2Api.unregisterV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationV2Api();

try {
    $result = $api_instance->unregisterV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationV2Api->unregisterV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationV2Api->new();

eval {
    my $result = $api_instance->unregisterV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationV2Api->unregisterV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationV2Api()

try:
    # Unregister
    api_response = api_instance.unregister_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationV2Api->unregisterV2: %s\n" % e)
extern crate WebNotificationV2Api;

pub fn main() {

    let mut context = WebNotificationV2Api::Context::default();
    let result = client.unregisterV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


WebNotificationV3

getAppInfoV3

Get App Info

TODO


/api/v3/push/web/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/push/web/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationV3Api;

import java.io.File;
import java.util.*;

public class WebNotificationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebNotificationV3Api apiInstance = new WebNotificationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAppInfoV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV3Api#getAppInfoV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationV3Api;

public class WebNotificationV3ApiExample {
    public static void main(String[] args) {
        WebNotificationV3Api apiInstance = new WebNotificationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.getAppInfoV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV3Api#getAppInfoV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
WebNotificationV3Api *apiInstance = [[WebNotificationV3Api alloc] init];

// Get App Info
[apiInstance getAppInfoV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.WebNotificationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAppInfoV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new WebNotificationV3Api();

            try {
                // Get App Info
                oas_any_type_not_mapped result = apiInstance.getAppInfoV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationV3Api.getAppInfoV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationV3Api();

try {
    $result = $api_instance->getAppInfoV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationV3Api->getAppInfoV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationV3Api->new();

eval {
    my $result = $api_instance->getAppInfoV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationV3Api->getAppInfoV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationV3Api()

try:
    # Get App Info
    api_response = api_instance.get_app_info_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationV3Api->getAppInfoV3: %s\n" % e)
extern crate WebNotificationV3Api;

pub fn main() {

    let mut context = WebNotificationV3Api::Context::default();
    let result = client.getAppInfoV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


registerV3

Register

TODO


/api/v3/push/web/register

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/push/web/register"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationV3Api;

import java.io.File;
import java.util.*;

public class WebNotificationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebNotificationV3Api apiInstance = new WebNotificationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.registerV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV3Api#registerV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationV3Api;

public class WebNotificationV3ApiExample {
    public static void main(String[] args) {
        WebNotificationV3Api apiInstance = new WebNotificationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.registerV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV3Api#registerV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
WebNotificationV3Api *apiInstance = [[WebNotificationV3Api alloc] init];

// Register
[apiInstance registerV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.WebNotificationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new WebNotificationV3Api();

            try {
                // Register
                oas_any_type_not_mapped result = apiInstance.registerV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationV3Api.registerV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationV3Api();

try {
    $result = $api_instance->registerV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationV3Api->registerV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationV3Api->new();

eval {
    my $result = $api_instance->registerV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationV3Api->registerV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationV3Api()

try:
    # Register
    api_response = api_instance.register_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationV3Api->registerV3: %s\n" % e)
extern crate WebNotificationV3Api;

pub fn main() {

    let mut context = WebNotificationV3Api::Context::default();
    let result = client.registerV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


unregisterV3

Unregister

TODO


/api/v3/push/web/revoke

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/push/web/revoke"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationV3Api;

import java.io.File;
import java.util.*;

public class WebNotificationV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebNotificationV3Api apiInstance = new WebNotificationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unregisterV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV3Api#unregisterV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationV3Api;

public class WebNotificationV3ApiExample {
    public static void main(String[] args) {
        WebNotificationV3Api apiInstance = new WebNotificationV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.unregisterV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationV3Api#unregisterV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
WebNotificationV3Api *apiInstance = [[WebNotificationV3Api alloc] init];

// Unregister
[apiInstance unregisterV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.WebNotificationV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unregisterV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new WebNotificationV3Api();

            try {
                // Unregister
                oas_any_type_not_mapped result = apiInstance.unregisterV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationV3Api.unregisterV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationV3Api();

try {
    $result = $api_instance->unregisterV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationV3Api->unregisterV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationV3Api->new();

eval {
    my $result = $api_instance->unregisterV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationV3Api->unregisterV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationV3Api()

try:
    # Unregister
    api_response = api_instance.unregister_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationV3Api->unregisterV3: %s\n" % e)
extern crate WebNotificationV3Api;

pub fn main() {

    let mut context = WebNotificationV3Api::Context::default();
    let result = client.unregisterV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


WebhookV2

connectedAccount

Connected Account

TODO - Not used in Floatplane code.


/api/v2/webhooks/connectedAccount/{site}

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/webhooks/connectedAccount/{site}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebhookV2Api;

import java.io.File;
import java.util.*;

public class WebhookV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebhookV2Api apiInstance = new WebhookV2Api();
        String site = site_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.connectedAccount(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookV2Api#connectedAccount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebhookV2Api;

public class WebhookV2ApiExample {
    public static void main(String[] args) {
        WebhookV2Api apiInstance = new WebhookV2Api();
        String site = site_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.connectedAccount(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookV2Api#connectedAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
WebhookV2Api *apiInstance = [[WebhookV2Api alloc] init];
String *site = site_example; //  (default to null)

// Connected Account
[apiInstance connectedAccountWith:site
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.WebhookV2Api()
var site = site_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.connectedAccount(site, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new WebhookV2Api();
            var site = site_example;  // String |  (default to null)

            try {
                // Connected Account
                oas_any_type_not_mapped result = apiInstance.connectedAccount(site);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebhookV2Api.connectedAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebhookV2Api();
$site = site_example; // String | 

try {
    $result = $api_instance->connectedAccount($site);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhookV2Api->connectedAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebhookV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebhookV2Api->new();
my $site = site_example; # String | 

eval {
    my $result = $api_instance->connectedAccount(site => $site);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhookV2Api->connectedAccount: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebhookV2Api()
site = site_example # String |  (default to null)

try:
    # Connected Account
    api_response = api_instance.connected_account(site)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhookV2Api->connectedAccount: %s\n" % e)
extern crate WebhookV2Api;

pub fn main() {
    let site = site_example; // String

    let mut context = WebhookV2Api::Context::default();
    let result = client.connectedAccount(site, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
site*
String
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


WebhookV3

iVSlivestreamPublish

IVS Livestream Publish

TODO - Not used in Floatplane code.


/api/v3/webhooks/ivs/livestream

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/webhooks/ivs/livestream"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebhookV3Api;

import java.io.File;
import java.util.*;

public class WebhookV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebhookV3Api apiInstance = new WebhookV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.iVSlivestreamPublish();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookV3Api#iVSlivestreamPublish");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebhookV3Api;

public class WebhookV3ApiExample {
    public static void main(String[] args) {
        WebhookV3Api apiInstance = new WebhookV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.iVSlivestreamPublish();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookV3Api#iVSlivestreamPublish");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
WebhookV3Api *apiInstance = [[WebhookV3Api alloc] init];

// IVS Livestream Publish
[apiInstance iVSlivestreamPublishWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.WebhookV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.iVSlivestreamPublish(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new WebhookV3Api();

            try {
                // IVS Livestream Publish
                oas_any_type_not_mapped result = apiInstance.iVSlivestreamPublish();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebhookV3Api.iVSlivestreamPublish: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebhookV3Api();

try {
    $result = $api_instance->iVSlivestreamPublish();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhookV3Api->iVSlivestreamPublish: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebhookV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebhookV3Api->new();

eval {
    my $result = $api_instance->iVSlivestreamPublish();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhookV3Api->iVSlivestreamPublish: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebhookV3Api()

try:
    # IVS Livestream Publish
    api_response = api_instance.i_v_slivestream_publish()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhookV3Api->iVSlivestreamPublish: %s\n" % e)
extern crate WebhookV3Api;

pub fn main() {

    let mut context = WebhookV3Api::Context::default();
    let result = client.iVSlivestreamPublish(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


livestreamPublish

Livestream Publish

TODO - Not used in Floatplane code.


/api/v3/webhooks/livestream

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/webhooks/livestream"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebhookV3Api;

import java.io.File;
import java.util.*;

public class WebhookV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebhookV3Api apiInstance = new WebhookV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.livestreamPublish();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookV3Api#livestreamPublish");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebhookV3Api;

public class WebhookV3ApiExample {
    public static void main(String[] args) {
        WebhookV3Api apiInstance = new WebhookV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.livestreamPublish();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookV3Api#livestreamPublish");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
WebhookV3Api *apiInstance = [[WebhookV3Api alloc] init];

// Livestream Publish
[apiInstance livestreamPublishWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.WebhookV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.livestreamPublish(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new WebhookV3Api();

            try {
                // Livestream Publish
                oas_any_type_not_mapped result = apiInstance.livestreamPublish();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebhookV3Api.livestreamPublish: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebhookV3Api();

try {
    $result = $api_instance->livestreamPublish();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhookV3Api->livestreamPublish: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebhookV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebhookV3Api->new();

eval {
    my $result = $api_instance->livestreamPublish();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhookV3Api->livestreamPublish: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebhookV3Api()

try:
    # Livestream Publish
    api_response = api_instance.livestream_publish()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhookV3Api->livestreamPublish: %s\n" % e)
extern crate WebhookV3Api;

pub fn main() {

    let mut context = WebhookV3Api::Context::default();
    let result = client.livestreamPublish(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.