Skip to content

Latest commit

 

History

History
241 lines (159 loc) · 5.78 KB

SearchdecoratorsApi.md

File metadata and controls

241 lines (159 loc) · 5.78 KB

graylog.SearchdecoratorsApi

All URIs are relative to http://log.ano.yumimobi.com/api

Method HTTP request Description
create POST /search/decorators Creates a message decoration configuration
delete DELETE /search/decorators/{decoratorId} Create a decorator
get GET /search/decorators Returns all configured message decorations
get_available GET /search/decorators/available Returns all available message decorations
update PUT /search/decorators/{decoratorId} Update a decorator

create

Decorator create(json_body)

Creates a message decoration configuration

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SearchdecoratorsApi()
json_body = graylog.DecoratorImpl() # DecoratorImpl | 

try: 
    # Creates a message decoration configuration
    api_response = api_instance.create(json_body)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SearchdecoratorsApi->create: %s\n" % e

Parameters

Name Type Description Notes
json_body DecoratorImpl

Return type

Decorator

Authorization

No authorization required

HTTP request headers

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

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

delete

delete(decorator_id)

Create a decorator

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SearchdecoratorsApi()
decorator_id = graylog.Object() # Object | 

try: 
    # Create a decorator
    api_instance.delete(decorator_id)
except ApiException as e:
    print "Exception when calling SearchdecoratorsApi->delete: %s\n" % e

Parameters

Name Type Description Notes
decorator_id Object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

get

List get()

Returns all configured message decorations

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SearchdecoratorsApi()

try: 
    # Returns all configured message decorations
    api_response = api_instance.get()
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SearchdecoratorsApi->get: %s\n" % e

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

HTTP request headers

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

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

get_available

Map get_available()

Returns all available message decorations

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SearchdecoratorsApi()

try: 
    # Returns all available message decorations
    api_response = api_instance.get_available()
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SearchdecoratorsApi->get_available: %s\n" % e

Parameters

This endpoint does not need any parameter.

Return type

Map

Authorization

No authorization required

HTTP request headers

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

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

update

Decorator update(decorator_id, json_body)

Update a decorator

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SearchdecoratorsApi()
decorator_id = graylog.Object() # Object | 
json_body = graylog.DecoratorImpl() # DecoratorImpl | 

try: 
    # Update a decorator
    api_response = api_instance.update(decorator_id, json_body)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SearchdecoratorsApi->update: %s\n" % e

Parameters

Name Type Description Notes
decorator_id Object
json_body DecoratorImpl

Return type

Decorator

Authorization

No authorization required

HTTP request headers

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

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