Skip to content

FormatsApi.md

Latest commit

 

History

History
122 lines (87 loc) · 3.54 KB

FormatsApi.md

File metadata and controls

122 lines (87 loc) · 3.54 KB

cloudsmith_api.FormatsApi

All URIs are relative to https://api.cloudsmith.io

Method HTTP request Description
formats_list GET /formats/ Get a list of all supported package formats.
formats_read GET /formats/{slug}/ Get a specific supported package format.

formats_list

list[Format] formats_list()

Get a list of all supported package formats.

Get a list of all supported package formats.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.FormatsApi(cloudsmith_api.ApiClient(configuration))

try:
    # Get a list of all supported package formats.
    api_response = api_instance.formats_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormatsApi->formats_list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Format]

Authorization

apikey, basic

HTTP request headers

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

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

formats_read

Format formats_read(slug)

Get a specific supported package format.

Get a specific supported package format.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.FormatsApi(cloudsmith_api.ApiClient(configuration))
slug = 'slug_example' # str | 

try:
    # Get a specific supported package format.
    api_response = api_instance.formats_read(slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormatsApi->formats_read: %s\n" % e)

Parameters

Name Type Description Notes
slug str

Return type

Format

Authorization

apikey, basic

HTTP request headers

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

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