phrase_api.BlacklistedKeysApi

All URIs are relative to https://api.phrase.com/v2

Method	HTTP request	Description
blacklisted_key_create	POST /projects/{project_id}/blacklisted_keys	Create a blocked key
blacklisted_key_delete	DELETE /projects/{project_id}/blacklisted_keys/{id}	Delete a blocked key
blacklisted_key_show	GET /projects/{project_id}/blacklisted_keys/{id}	Get a single blocked key
blacklisted_key_update	PATCH /projects/{project_id}/blacklisted_keys/{id}	Update a blocked key
blacklisted_keys_list	GET /projects/{project_id}/blacklisted_keys	List blocked keys

blacklisted_key_create

BlacklistedKey blacklisted_key_create(project_id, blacklisted_key_create_parameters, x_phrase_app_otp=x_phrase_app_otp)

Create a blocked key

Create a new rule for blocking keys.

Example

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

configuration = phrase_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'token'

# Enter a context with an instance of the API client
with phrase_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrase_api.BlacklistedKeysApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    blacklisted_key_create_parameters = phrase_api.BlacklistedKeyCreateParameters() # BlacklistedKeyCreateParameters |  (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)

    try:
        # Create a blocked key
        api_response = api_instance.blacklisted_key_create(project_id, blacklisted_key_create_parameters, x_phrase_app_otp=x_phrase_app_otp)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BlacklistedKeysApi->blacklisted_key_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
blacklisted_key_create_parameters	BlacklistedKeyCreateParameters
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]

Return type

BlacklistedKey

Authorization

Basic, Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
401	Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.	-
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
422	Unprocessable entity. The request was well-formed but failed validation. The response body lists each offending field in the `errors` array, with its resource, field, and a human-readable message. Correct the listed fields and retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

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

blacklisted_key_delete

blacklisted_key_delete(project_id, id, x_phrase_app_otp=x_phrase_app_otp)

Delete a blocked key

Delete an existing rule for blocking keys.

Example

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

configuration = phrase_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'token'

# Enter a context with an instance of the API client
with phrase_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrase_api.BlacklistedKeysApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    id = 'id_example' # str | ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)

    try:
        # Delete a blocked key
        api_instance.blacklisted_key_delete(project_id, id, x_phrase_app_otp=x_phrase_app_otp)
    except ApiException as e:
        print("Exception when calling BlacklistedKeysApi->blacklisted_key_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
id	str	ID
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]

Return type

void (empty response body)

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	The resource was deleted successfully.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
401	Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.	-
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
422	Unprocessable entity. The request was well-formed but failed validation. The response body lists each offending field in the `errors` array, with its resource, field, and a human-readable message. Correct the listed fields and retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

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

blacklisted_key_show

BlacklistedKey blacklisted_key_show(project_id, id, x_phrase_app_otp=x_phrase_app_otp)

Get a single blocked key

Get details on a single rule for blocking keys for a given project.

Example

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

configuration = phrase_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'token'

# Enter a context with an instance of the API client
with phrase_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrase_api.BlacklistedKeysApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    id = 'id_example' # str | ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)

    try:
        # Get a single blocked key
        api_response = api_instance.blacklisted_key_show(project_id, id, x_phrase_app_otp=x_phrase_app_otp)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BlacklistedKeysApi->blacklisted_key_show: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
id	str	ID
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]

Return type

BlacklistedKey

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
401	Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.	-
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

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

blacklisted_key_update

BlacklistedKey blacklisted_key_update(project_id, id, blacklisted_key_update_parameters, x_phrase_app_otp=x_phrase_app_otp)

Update a blocked key

Update an existing rule for blocking keys.

Example

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

configuration = phrase_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'token'

# Enter a context with an instance of the API client
with phrase_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrase_api.BlacklistedKeysApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    id = 'id_example' # str | ID (required)
    blacklisted_key_update_parameters = phrase_api.BlacklistedKeyUpdateParameters() # BlacklistedKeyUpdateParameters |  (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)

    try:
        # Update a blocked key
        api_response = api_instance.blacklisted_key_update(project_id, id, blacklisted_key_update_parameters, x_phrase_app_otp=x_phrase_app_otp)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BlacklistedKeysApi->blacklisted_key_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
id	str	ID
blacklisted_key_update_parameters	BlacklistedKeyUpdateParameters
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]

Return type

BlacklistedKey

Authorization

Basic, Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
401	Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.	-
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
422	Unprocessable entity. The request was well-formed but failed validation. The response body lists each offending field in the `errors` array, with its resource, field, and a human-readable message. Correct the listed fields and retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

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

blacklisted_keys_list

List[BlacklistedKey] blacklisted_keys_list(project_id, x_phrase_app_otp=x_phrase_app_otp, page=page, per_page=per_page, branch=branch)

List blocked keys

List all rules for blocking keys for the given project.

Example

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

configuration = phrase_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'token'

# Enter a context with an instance of the API client
with phrase_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrase_api.BlacklistedKeysApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
    page = 1 # int | Page number
    per_page = 25 # int | Limit on the number of objects to be returned, between 1 and 100. 25 by default
    branch = 'my-feature-branch' # str | specify the branch to use

    try:
        # List blocked keys
        api_response = api_instance.blacklisted_keys_list(project_id, x_phrase_app_otp=x_phrase_app_otp, page=page, per_page=per_page, branch=branch)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BlacklistedKeysApi->blacklisted_keys_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]
page	int	Page number	[optional]
per_page	int	Limit on the number of objects to be returned, between 1 and 100. 25 by default	[optional]
branch	str	specify the branch to use	[optional]

Return type

List[BlacklistedKey]

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset - * Link - * Pagination -
400	Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
401	Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.	-
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

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

Navigation Menu

Uh oh!

phrase_api.BlacklistedKeysApi

blacklisted_key_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

blacklisted_key_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

blacklisted_key_show

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

blacklisted_key_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

blacklisted_keys_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Uh oh!

FilesExpand file tree

BlacklistedKeysApi.md

Latest commit

History

BlacklistedKeysApi.md

File metadata and controls

phrase_api.BlacklistedKeysApi

blacklisted_key_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

blacklisted_key_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

blacklisted_key_show

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

blacklisted_key_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

blacklisted_keys_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details