Overview
  • Namespace
  • Class

Namespaces

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

Classes

  • PhishClient

Class PhishClient

Interact with the Phish (UBL) API

Class PhishClient

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

Methods summary

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

Searches the Phish module

Searches the Phish 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 phish id
$options
an associative array of query parameters

Returns

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

Submits a new phish

Submits a new phish

Parameters

$data
an associative array of phish data
$options
an associative array pf query parameters

Returns

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

Marks a phish as inactive

Marks a phish as inactive

Deprecated

Parameters

$id
the phish id

Returns

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

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

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

Parameters

$id
the phish id

Returns

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

Updates a phish

Updates a phish

Parameters

$id
the phish id
$data
$options

Returns

Psr\Http\Message\ResponseInterface
public Psr\Http\Message\ResponseInterface
# revive( integer $id, array $data )

Revives an inactive phish

Revives an inactive phish

Deprecated

Parameters

$id
the phish id
$data

Returns

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

Searches the UBL activity listing

Searches the UBL activity listing

Parameters

$options
an associative array of query parameters

Returns

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

Get the UBL activity listings for a specific phish

Get the UBL activity listings for a specific phish

Parameters

$id
$options

Returns

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

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

Return a JSON schema for the phish module's GET:/phish 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