Syniverse Whitelisting Service API

Developer Community gateway service for managing whitelists of entities and transactions, used to allow trial-account destination numbers and similar platform-level allow lists. Six operations across whitelist, entity and transaction resources.

OpenAPI Specification

syniverse-whitelisting-service-openapi.json Raw ↑
{
    "paths": {
        "/whitelist/{WHITELIST_ID}": {
            "post": {
                "security": [
                    {
                        "default": []
                    }
                ],
                "x-auth-type": "Application & Application User",
                "operationId": "post_whitelist/{WHITELIST_ID}",
                "responses": {
                    "200": {
                        "description": "No response was specified"
                    }
                },
                "parameters": [
                    {
                        "schema": {
                            "type": "string",
                            "properties": {
                                "payload": {
                                    "type": "string"
                                }
                            }
                        },
                        "in": "body",
                        "name": "body",
                        "description": "Request Body",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "WHITELIST_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    }
                ],
                "x-throttling-tier": "Unlimited",
                "tags": [
                    "whitelist"
                ]
            },
            "get": {
                "security": [
                    {
                        "default": []
                    }
                ],
                "x-auth-type": "Application & Application User",
                "operationId": "get_whitelist/{WHITELIST_ID}",
                "responses": {
                    "200": {
                        "description": "No response was specified"
                    }
                },
                "parameters": [
                    {
                        "schema": {
                            "type": "string",
                            "properties": {
                                "payload": {
                                    "type": "string"
                                }
                            }
                        },
                        "in": "body",
                        "name": "body",
                        "description": "Request Body",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "WHITELIST_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    }
                ],
                "x-throttling-tier": "Unlimited",
                "tags": [
                    "whitelist"
                ]
            }
        },
        "/whitelist/{WHITELIST_ID}/{ENTITY_ID}": {
            "get": {
                "security": [
                    {
                        "default": []
                    }
                ],
                "x-auth-type": "Application & Application User",
                "operationId": "get_whitelist/{WHITELIST_ID}/{ENTITY_ID}",
                "responses": {
                    "200": {
                        "description": "No response was specified"
                    }
                },
                "parameters": [
                    {
                        "schema": {
                            "type": "string",
                            "properties": {
                                "payload": {
                                    "type": "string"
                                }
                            }
                        },
                        "in": "body",
                        "name": "body",
                        "description": "Request Body",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "WHITELIST_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "ENTITY_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    }
                ],
                "x-throttling-tier": "Unlimited",
                "tags": [
                    "whitelist"
                ]
            },
            "delete": {
                "security": [
                    {
                        "default": []
                    }
                ],
                "x-auth-type": "Application & Application User",
                "operationId": "delete_whitelist/{WHITELIST_ID}/{ENTITY_ID}",
                "responses": {
                    "200": {
                        "description": "No response was specified"
                    }
                },
                "parameters": [
                    {
                        "schema": {
                            "type": "string",
                            "properties": {
                                "payload": {
                                    "type": "string"
                                }
                            }
                        },
                        "in": "body",
                        "name": "body",
                        "description": "Request Body",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "WHITELIST_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "ENTITY_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    }
                ],
                "x-throttling-tier": "Unlimited",
                "tags": [
                    "whitelist"
                ]
            }
        },
        "/whitelist/{WHITELIST_ID}/{ENTITY_ID}/{TRANSACTION_ID}": {
            "post": {
                "security": [
                    {
                        "default": []
                    }
                ],
                "x-auth-type": "Application & Application User",
                "operationId": "post_whitelist/{WHITELIST_ID}/{ENTITY_ID}/{TRANSACTION_ID}",
                "responses": {
                    "200": {
                        "description": "No response was specified"
                    }
                },
                "parameters": [
                    {
                        "schema": {
                            "type": "string",
                            "properties": {
                                "payload": {
                                    "type": "string"
                                }
                            }
                        },
                        "in": "body",
                        "name": "body",
                        "description": "Request Body",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "WHITELIST_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "ENTITY_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "TRANSACTION_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    }
                ],
                "x-throttling-tier": "Unlimited",
                "tags": [
                    "whitelist"
                ]
            },
            "get": {
                "security": [
                    {
                        "default": []
                    }
                ],
                "x-auth-type": "Application & Application User",
                "operationId": "get_whitelist/{WHITELIST_ID}/{ENTITY_ID}/{TRANSACTION_ID}",
                "responses": {
                    "200": {
                        "description": "No response was specified"
                    }
                },
                "parameters": [
                    {
                        "schema": {
                            "type": "string",
                            "properties": {
                                "payload": {
                                    "type": "string"
                                }
                            }
                        },
                        "in": "body",
                        "name": "body",
                        "description": "Request Body",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "WHITELIST_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "ENTITY_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    },
                    {
                        "in": "path",
                        "name": "TRANSACTION_ID",
                        "description": "",
                        "type": "string",
                        "required": true
                    }
                ],
                "x-throttling-tier": "Unlimited",
                "tags": [
                    "whitelist"
                ]
            }
        }
    },
    "definitions": {
        "sampleItem": {}
    },
    "securityDefinitions": {
        "default": {
            "authorizationUrl": "https://beta.api.syniverse.com/token",
            "scopes": {},
            "type": "oauth2",
            "flow": "implicit"
        }
    },
    "swagger": "2.0",
    "x-wso2-security": {
        "apim": {
            "tokenUrl": "",
            "authorizationUrl": "",
            "in": "",
            "name": "",
            "description": "",
            "scopes": "",
            "type": "",
            "x-wso2-scopes": [],
            "flow": ""
        }
    },
    "info": {
        "license": {
            "name": "",
            "url": ""
        },
        "contact": {
            "name": ""
        },
        "description": "",
        "termsOfService": "",
        "title": "Whitelisting_Service",
        "version": "v1"
    }
}