view release on metacpan or  search on metacpan

docs/RootServerApi.md  view on Meta::CPAN

void (empty response body)

### Authorization

[bmltToken](../README.md#bmltToken)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **auth_refresh**
> Token auth_refresh()

Revokes and issues a new token

Refresh token.

### Example
```perl
use Data::Dumper;
use BmltClient::RootServerApi;
my $api_instance = BmltClient::RootServerApi->new(

    # Configure OAuth2 access token for authorization: bmltToken
    access_token => 'YOUR_ACCESS_TOKEN',
);


eval {
    my $result = $api_instance->auth_refresh();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RootServerApi->auth_refresh: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**Token**](Token.md)

### Authorization

[bmltToken](../README.md#bmltToken)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **auth_token**
> Token auth_token(token_credentials => $token_credentials)

Creates a token

Exchange credentials for a new token

### Example
```perl
use Data::Dumper;
use BmltClient::RootServerApi;
my $api_instance = BmltClient::RootServerApi->new(
);

my $token_credentials = BmltClient::Object::TokenCredentials->new(); # TokenCredentials | User credentials

eval {
    my $result = $api_instance->auth_token(token_credentials => $token_credentials);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RootServerApi->auth_token: $@\n";
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **token_credentials** | [**TokenCredentials**](TokenCredentials.md)| User credentials | 

### Return type

[**Token**](Token.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_format**
> Format create_format(format_create => $format_create)

Creates a format

Creates a format.

### Example
```perl
use Data::Dumper;
use BmltClient::RootServerApi;
my $api_instance = BmltClient::RootServerApi->new(

    # Configure OAuth2 access token for authorization: bmltToken
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $format_create = BmltClient::Object::FormatCreate->new(); # FormatCreate | Pass in format object

eval {
    my $result = $api_instance->create_format(format_create => $format_create);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RootServerApi->create_format: $@\n";
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **format_create** | [**FormatCreate**](FormatCreate.md)| Pass in format object | 

### Return type

[**Format**](Format.md)

### Authorization

[bmltToken](../README.md#bmltToken)

### HTTP request headers