Overview
  • Namespace
  • Class

Namespaces

  • APWG
    • API
      • Alerts
      • Groups
      • Index
      • MalIP
      • Phish
      • ReportPhishing

Classes

  • MalIPClient

Class MalIPClient

Interact with the Mal_IP API

Class MalIPClient

APWG\API\AbstractClient implements APWG\API\ClientInterface
Extended by APWG\API\MalIP\MalIPClient
Namespace: APWG\API\MalIP
Package: APWG\API\MalIP
Copyright: Copyright (c) 2017 The Anti-Phishing Working Group
Author: Andrew Breksa andrew@apwg.org
Located at APWG/API/MalIP/MalIPClient.php

Methods summary

public Psr\Http\Message\ResponseInterface
# search( array $options = [] )

Searches the mal_ip module

Searches the mal_ip module

Parameters

$options
an associative array of query parameters

Returns

Psr\Http\Message\ResponseInterface
public Psr\Http\Message\ResponseInterface
# get( integer $id, array $options = [] )

Gets a specific phish

Gets a specific phish

Parameters

$id
the mal_ip id
$options
an associative array of query parameters

Returns

Psr\Http\Message\ResponseInterface
public Psr\Http\Message\ResponseInterface
# head( integer $id )

Checks that a mal_ip by that ID exists and returns a last-modified header

Checks that a mal_ip by that ID exists and returns a last-modified header

Parameters

$id
the mal_ip id

Returns

Psr\Http\Message\ResponseInterface
public Psr\Http\Message\ResponseInterface
# create( array $data, array $options = [] )

Submits a new mal_ip entry

Submits a new mal_ip entry

Parameters

$data
an associative array of mal_ip data
$options
an associative array of query parameters

Returns

Psr\Http\Message\ResponseInterface
public Psr\Http\Message\ResponseInterface
# lastCollaboration( integer $id )

Get a Last-Modified header with the timestamp of the last collaboration activity for a specific entity

Get a Last-Modified header with the timestamp of the last collaboration activity for a specific entity

Parameters

$id

Returns

Psr\Http\Message\ResponseInterface
public Psr\Http\Message\ResponseInterface
# getParamSchema( integer $options = [], array $options,… )

Return a JSON schema for the mal_ip module's GET:/mal_ip endpoint parameters, useful for validating Alert queries

Return a JSON schema for the mal_ip module's GET:/mal_ip endpoint parameters, useful for validating Alert queries

Parameters

$options
$id the phish id
$options,…
an associative array of query parameters

Returns

Psr\Http\Message\ResponseInterface

Methods inherited from APWG\API\AbstractClient

__construct(), _call(), getApiKey(), getBaseUri(), getCache(), getClient(), getGlobalOptions(), getGuzzleOptions(), setApiKey(), setBaseUri(), setCache(), setClient(), setGlobalOptions(), setGuzzleOptions()

Properties summary

Properties inherited from APWG\API\AbstractClient

$apiKey, $base_uri, $cache, $client, $globalOptions, $guzzleOptions

API documentation generated by ApiGen